Technical writing: Difference between revisions
Appearance
No edit summary |
|||
| Line 11: | Line 11: | ||
* Steps by steps process and screenshots | * Steps by steps process and screenshots | ||
** Is it possible to reduct the number of steps to reduce the cognitive load? | |||
* Verify the entry point before using the software | * Verify the entry point before using the software | ||
Revision as of 15:22, 31 March 2022
Software installation guide checklist
- Requirement of software and hardware<ref>Installation Guide Checklist: Sample Template For Technical Writers</ref>
- Package dependency
- Expected result after the software installed successfully
- Troubleshooting
Software documentation checklist
- Steps by steps process and screenshots
- Is it possible to reduct the number of steps to reduce the cognitive load?
- Verify the entry point before using the software
References
<references />