Technical writing: Difference between revisions

From LemonWiki共筆
Jump to navigation Jump to search
(Created page with "{{Draft}} == Software installation guide checklist == * Requirement of software and hardware * Package dependency * Expected result after the software installed successfully...")
 
No edit summary
Line 3: Line 3:
== Software installation guide checklist ==
== Software installation guide checklist ==


* Requirement of software and hardware
* Requirement of software and hardware<ref>[https://www.klariti.com/technical-writing/2015/05/14/installation-guide-checklist-sample-writing-template/ Installation Guide Checklist: Sample Template For Technical Writers]</ref>
* Package dependency
* Package dependency
* Expected result after the software installed successfully
* Expected result after the software installed successfully
Line 12: Line 12:
* Steps by steps process and screenshots
* Steps by steps process and screenshots
* Verify the entry point before using the software
* Verify the entry point before using the software
== References ==
<references />




[[Category:Programming]] [[Category:Software]]
[[Category:Programming]] [[Category:Software]]

Revision as of 20:15, 19 May 2021


icon_scale_pencil.png 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
  • Verify the entry point before using the software

References