Technical writing: Difference between revisions

Technical writing (edit)

147 bytes added , 7 December 2023

Anonymous user

@@ Line 10: / Line 10: @@
 == Software documentation checklist ==
-* Steps by steps process and screenshots
+* Simplified Step-by-Step Guide with Visuals:
-** Is it possible to reduct the total number of steps in order to reduce the cognitive load?
-* Verify the entry point before using the software
+** Consider minimizing the number of steps to lessen complexity for users.
-* Copy & paste the commands from the documentation
-** The PDF will insert the line break into the command if the length of command is too long<ref>[https://stackoverflow.com/questions/18599711/how-can-i-split-a-shell-command-over-multiple-lines-when-using-an-if-statement syntax - How can I split a shell command over multiple lines when using an IF statement? - Stack Overflow]</ref>
+* Confirm Starting Point:
+** Ensure the initial setup or entry point is verified prior to software usage.
+* Command Replication:
+** 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.
+* Clarity and Precision of Examples:
+** Evaluate if examples are straightforward and detailed, including explanations of fields and sourcing of specific values.
+Example for reference:
+<pre>
+{"survey_id":"SURVEY","hash":"xxxxxx"}
+</pre>
 == ChatGPT Prompt for technical writing ==