from Hacker News

Best Practices for Writing Solid Software Documentation

by Jeff_K on 9/5/23, 9:17 AM with 1 comments

• by robaczek333 on 9/5/23, 9:23 AM

  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.