15,043
edits
Technical writing: Difference between revisions
Jump to navigation
Jump to search
m
→Related pages
m (→Related pages) |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 8: | Line 8: | ||
* Troubleshooting | * Troubleshooting | ||
== Software | == Software Documentation Checklist == | ||
* Simplified Step-by-Step Guide with Visuals: | * Simplified Step-by-Step Guide with Visuals: [⭐ Beginner Friendly] | ||
** Consider minimizing the number of steps to lessen complexity for users. | ** Consider minimizing the number of steps to lessen complexity for users. | ||
** Include clear screenshots or diagrams for each major step. | |||
** Difficulty: Easy - Visual guides help new users follow along intuitively. | |||
* Confirm Starting Point: | * Clarity and Precision of Examples: [⭐ Beginner Friendly] | ||
** Evaluate if examples are straightforward and detailed, including explanations of fields and sourcing of specific values. | |||
** Use real-world scenarios that readers can relate to. | |||
** Difficulty: Easy - Examples are designed to be understood by all skill levels. | |||
Example for reference: How to get the source of id and hash values | |||
[⭐ Beginner Friendly] | |||
<pre> | |||
{"id":"123","hash":"xxxxxx"} | |||
</pre> | |||
* Confirm Starting Point: [⭐⭐ Basic Experience Needed] | |||
** 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. | ||
** Include environment prerequisites and system requirements. | |||
** Difficulty: Moderate - Requires basic understanding of system configuration. | |||
* Command Replication: | * Command Replication: [⭐⭐⭐ Technical Knowledge Required] | ||
** 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. | ||
** Difficulty: Advanced - Users should understand command line basics and syntax. | |||
Difficulty Rating Scale: | |||
⭐ Beginner Friendly - No technical background needed | |||
⭐⭐ Basic Experience Needed - Familiarity with basic concepts required | |||
⭐⭐⭐ Technical Knowledge Required - Understanding of technical concepts necessary | |||
== ChatGPT Prompt for technical writing == | == ChatGPT Prompt for technical writing == | ||
| Line 55: | Line 68: | ||
== Related pages == | == Related pages == | ||
* [[Customer communication]] | * [[Customer communication]] | ||
* [[Quick start guide]] | |||
== Further reading == | == Further reading == | ||