Settings

Theme

Best Practices for Writing Solid Software Documentation

stratoflow.com

7 points by Jeff_K 2 years ago · 1 comment

Reader

robaczek333 2 years ago

The goal of any documentation is to help people. "Good" documentation is useful. "Bad" documentation confuses readers and might physically harm people or damage equipment.

Also, when writing documentation, consistency is quite important. Often this is resolved with something known as a style guide. Style guides might be formal or informal. I think that point 3 in this article mentions it quite well.

Keyboard Shortcuts

j
Next item
k
Previous item
o / Enter
Open selected item
?
Show this help
Esc
Close modal / clear selection