Technical writing: Difference between revisions
Jump to navigation
Jump to search
→Software documentation checklist
| Line 12: | Line 12: | ||
* Steps by steps process and screenshots | * Steps by steps process and screenshots | ||
** Is it possible to reduct the total number of steps in order to reduce the cognitive load? | ** 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 | * Verify the entry point before using the software | ||
* 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> | |||
== References == | == References == | ||