Technical writing: Difference between revisions

Revision as of 10:14, 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]

References

[1] Installation Guide Checklist: Sample Template For Technical Writers

[2] syntax - How can I split a shell command over multiple lines when using an IF statement? - Stack Overflow

[1]

[2]

Revision as of 15:26, 1 July 2022 (edit) Unknown user (talk) (→‎Software documentation checklist) ← Older edit		Revision as of 10:14, 30 October 2023 (edit) (undo) Unknown user (talk) No edit summary Newer edit →
Line 22:		Line 22:


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

Technical writing: Difference between revisions

Revision as of 10:14, 30 October 2023

Software installation guide checklist

Software documentation checklist

References

Navigation menu

Search