Technical writing

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<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 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<ref>syntax - How can I split a shell command over multiple lines when using an IF statement? - Stack Overflow</ref>

References

<references />