Technical writing: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 20: | Line 20: | ||
== Related pages == | == Related pages == | ||
* [[Customer communication]] | * [[Customer communication]] | ||
== Further reading == | |||
* [https://henrychu.substack.com/p/15b 📘 專業人士的明確溝通指南 - by Chi Chu - 亨利朱週報] | |||
== References == | == References == | ||
Revision as of 10:16, 30 October 2023
 This article "Technical writing" is still being written. If there are any incomplete parts, you are welcome to directly edit them. 這篇文章「Technical writing」內容還在撰寫中，如果有不完整的部分，歡迎你直接動手修改。
|
Software installation guide checklist
- Requirement of software and hardware[1]
- 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 total number of steps in order to reduce the cognitive load?
- 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[2]