Icons-Land Sport Vector Icons V2€¦ · Icons-Land Vista Sport Vector Icons V2.0
Professionalize Your Add-on or App with Icons and Documentation Best Practices
description
Transcript of Professionalize Your Add-on or App with Icons and Documentation Best Practices
![Page 1: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/1.jpg)
1
![Page 2: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/2.jpg)
2
Professionalize Your Add-on or App with Icons and
Documentation Best Practices
Robert Des Rosier, LabVIEW Partner ProgramLaura Hayden, R&D Graphic Designer
Steven Moser, Technical WriterNational Instruments
![Page 3: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/3.jpg)
3
Professionalize Your Add-on or App with Icons
Laura HaydenGraphic Designer
![Page 4: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/4.jpg)
4
What I Do
Consistency Reviewer
Image Translator
Icon Artist
![Page 5: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/5.jpg)
5
What "Professionalize" Means
• Brand Your API
• Think About Functionality
• Remove Text
• Don't Reinvent The Wheel
• Use Color Wisely
• Be Consistent
![Page 6: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/6.jpg)
6
Brand Your API
![Page 7: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/7.jpg)
7
Brand Your API
![Page 8: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/8.jpg)
8
Think About Functionality
![Page 9: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/9.jpg)
9
Remove Text
![Page 10: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/10.jpg)
10
Don’t Reinvent The Wheel
![Page 11: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/11.jpg)
11
Don’t Reinvent The Wheel
![Page 12: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/12.jpg)
12
Use Color Wisely
vischeck.com
![Page 13: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/13.jpg)
13
Be Consistent
verb
object
Add Network Device
![Page 14: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/14.jpg)
14
Be Consistent
Get Disk Image
![Page 15: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/15.jpg)
15
Be Consistent
Clear Image Database
![Page 16: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/16.jpg)
16
Putting It All Together
![Page 17: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/17.jpg)
17
Putting It All Together
![Page 18: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/18.jpg)
18
Putting It All Together
![Page 19: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/19.jpg)
19
Tools / ResourcesLabVIEW Icon editor
Axialis Icon Workshop
Corel Paint Shop Pro
ni.com/iconlibrary
eTrainings at ni.com/addondevcenter
![Page 20: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/20.jpg)
20
Summary
• Brand Your API
• Think About Functionality
• Remove Text
• Don't Reinvent The Wheel
• Use Color Wisely
• Be Consistent
![Page 21: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/21.jpg)
21
Professionalize Your Add-on with Documentation Best Practices
Steven MoserTechnical Writer
National Instruments
![Page 22: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/22.jpg)
22
Who Am I?• Technical writer = writing + testing + usability
LabVIEW Development System Robotics Module MathScript RT Module Control Design & Simulation Module Jitter Analysis Toolkit Third Party Licensing & Activation Toolkit VI Analyzer Toolkit
![Page 23: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/23.jpg)
23
Why Is Documentation Important?
![Page 24: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/24.jpg)
24
Why Is Documentation Important?• Documentation is a product feature
Supplements the software Adds credibility to your products
• Reduces number of support calls• Meets Compatible with LabVIEW requirements
![Page 25: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/25.jpg)
25
Compatible with LabVIEW GuidanceMinimum Recommended
Installing/upgrading X X
Activating X X
Software/hardware/system requirements X X
Getting started guidance X X
Getting support X
Purchasing X
Context Help for VIs/inputs/outputs X
Detailed help topics X
![Page 26: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/26.jpg)
26
What Kind of Documentation is Important?
Goal: Answer “pre-use” questions
Research product
Install/upgrade
Getting started Use features
Goal: Provide in-product support for features
Useractivities
![Page 27: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/27.jpg)
27
Pre-Use Education• How do I install?• If I upgrade, what new features/bug fixes are available?• What OSes are supported? Which LabVIEW versions?• Where do I find features, examples, and help so I can get
started?• If I need support, how do I get it?• How do I purchase your product?
![Page 28: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/28.jpg)
28
Pre-Use EducationSolution: Readme files• Accessible prior to installation• Template available at ni.com/addondevcenter
![Page 29: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/29.jpg)
29
In-Product Support—Context HelpAnswer for users,“Does this fit my use case?”
![Page 30: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/30.jpg)
30
![Page 31: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/31.jpg)
31
In-Product Support—Context Help
VI descriptions
NOT “Acquires data.”
![Page 32: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/32.jpg)
32
In-Product Support—Context Help
“Returns two arrays that describe the magnitudes and angles of obstacles the device detects within a given range.”
![Page 33: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/33.jpg)
33
In-Product Support—Context Help
“Returns two arrays that describe the magnitudes and angles of obstacles the device detects within a given range.”
Verb Output(s) Input(s)”
![Page 34: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/34.jpg)
34
In-Product Support—Context Help
“Returns two arrays that describe the magnitudes and angles of obstacles the device detects within a given range.”
Verb Output(s) Input(s)”
![Page 35: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/35.jpg)
35
In-Product Support—Context Help
“Returns two arrays that describe the magnitudes and angles of obstacles the device detects within a given range.”
Verb Output(s) Input(s)”
![Page 36: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/36.jpg)
36
In-Product Support—Context HelpVI descriptions
NOT “Forward kinematics of a robot arm is computed by this Forward Kinematics VI.”
![Page 37: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/37.jpg)
37
In-Product Support—Context Help
“Calculates the homogenous transform or transforms that represents the position of a robotic arm end effector given the joint angles of the arm.”
![Page 38: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/38.jpg)
38
In-Product Support—Context Help
“Calculates the homogenous transform or transforms that represents the position of a robotic arm end effector given the joint angles of the arm.”
Verb Output(s) Input(s)
![Page 39: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/39.jpg)
39
In-Product Support—Context Help
“Calculates the homogenous transform or transforms that represents the position of a robotic arm end effector given the joint angles of the arm.”
“Verb Output(s) Input(s)”
![Page 40: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/40.jpg)
40
In-Product Support—Context Help
“Calculates the homogenous transform or transforms that represents the position of a robotic arm end effector given the joint angles of the arm.”
“Verb Output(s) Input(s)”
![Page 41: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/41.jpg)
41
![Page 42: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/42.jpg)
42
In-Product Support—Context HelpInput/output descriptions• Provide information users otherwise must test:
NOT “path is the path to the log file.”
INSTEAD “path specifies an absolute path to the file to which you want to log data. If you specify an empty or relative path, this function returns an error.
![Page 43: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/43.jpg)
43
In-Product Support—Context HelpInput/output descriptions• Provide units in which values are expressed,
default values, error information NOT “timeout is the time to wait for a response.”
INSTEAD “timeout (ms) sets the amount of time to wait for a response from the host. If timeout (ms) elapses, this VI returns error code 5. If you set timeout (ms) to -1 (default), this VI waits indefinitely.
![Page 44: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/44.jpg)
44
In-Product Support—Detailed HelpExpand from “Does this fit my use case?”
to “How does this object work?”
![Page 45: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/45.jpg)
45
In-Product Support—Detailed Help• Cross references to relevant examples• Error codes VIs can return• Screenshots of workflows
![Page 46: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/46.jpg)
46
In-Product Support
Solution: Context help + HTML Help• Use tools from Partner team to populate
context help and generate detailed HTML help ni.com/addondevcenter
![Page 47: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/47.jpg)
47
Localization
• English ?• ? English• Vendors and tools exist worldwide, but…• Take advantage of each others’ knowledge—Ask
about solutions at ni.com/addondevcenter
![Page 48: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/48.jpg)
48
Summary
Deliverable: Readme file
Research product
Install/upgrade
Getting started Use features
Deliverables: Context help and HTML help
Useractivities
![Page 49: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/49.jpg)
49
Where to Go from Here• ni.com/addondevcenter
Readme HTML file template VI Properties Editor tool VI to XML tool for creating HTML Help
• Notepad++, KompoZer—HTML editors (free)• FAR—Compiled HTML Help (CHM) editor (purchase)
http://helpware.net/FAR/ Requires Microsoft HTML Help Workshop (free)
![Page 50: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/50.jpg)
50
Related Sessions
Hands-On: VI Package ManagerTuesday 10:30 AM 18C
Creating a Software Evaluation in 10 MinutesWednesday 2:15 PM 10C
LabVIEW Add-on of the YearWednesday 3:30 PM 10C
![Page 51: Professionalize Your Add-on or App with Icons and Documentation Best Practices](https://reader036.fdocuments.us/reader036/viewer/2022062411/568166ff550346895ddb6646/html5/thumbnails/51.jpg)
51
Alliance Partner Network 20th Anniversary Celebration
Join us for an evening of drinks, music, networking, and a celebratory toast by Dr. James Truchard at
5:30 p.m. in the exhibition hall.