Technical writing

From LemonWiki共筆
Jump to navigation Jump to search

icon_scale_pencil.png 這篇文章「Technical writing」內容還在撰寫中,如果有不完整的部分,歡迎你直接動手修改

Software installation guide checklist[edit]

  • Requirement of software and hardware[1]
  • Package dependency
  • Expected result after the software installed successfully
  • Troubleshooting

Software documentation checklist[edit]

  • 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]