Technical writing: Difference between revisions
Jump to navigation
Jump to search
m
→Software documentation checklist
| Line 11: | Line 11: | ||
* Simplified Step-by-Step Guide with Visuals: | * Simplified Step-by-Step Guide with Visuals: | ||
** Consider minimizing the number of steps to lessen complexity for users. | ** Consider minimizing the number of steps to lessen complexity for users. | ||
* Confirm Starting Point: | * Confirm Starting Point: | ||
** Ensure the initial setup or entry point is verified prior to software usage. | ** Ensure the initial setup or entry point is verified prior to software usage. | ||
* Command Replication: | * Command Replication: | ||
** Instructions for directly copying and pasting commands from the guide. | ** Instructions for directly copying and pasting commands from the guide. | ||
** Note: Lengthy commands in the PDF might be broken into lines. Refer to this Stack Overflow discussion for splitting shell commands across lines. | ** Note: Lengthy commands in the PDF might be broken into lines. Refer to this Stack Overflow discussion for splitting shell commands across lines. | ||
* Clarity and Precision of Examples: | * Clarity and Precision of Examples: | ||
** Evaluate if examples are straightforward and detailed, including explanations of fields and sourcing of specific values. | ** Evaluate if examples are straightforward and detailed, including explanations of fields and sourcing of specific values. | ||