News for hackers. Stuff that matters.
Re:Ask HN: What style guides are there for technical documen... by wsh on Friday May 29, 2020 @02:07PM (#23353431)
Here are some examples from the computer industry, all available at no charge:

• Apple Style Guide: https://books.apple.com/us/book/apple-style-guide/id11618552...

• Google Developer Documentation Style Guide: https://developers.google.com/style/

• Microsoft Writing Style Guide: https://docs.microsoft.com/en-us/style-guide/welcome/

I’ve found earlier editions of Microsoft’s guide to be helpful when writing about user interfaces on the Windows platform.

Other industries have their own conventions. For example, the maintenance manuals for commercial airplanes are often written in Simplified Technical English (http://asd-ste100.org/), and the Securities and Exchange Commission has published a Plain English Handbook (https://www.sec.gov/pdf/handbook.pdf).

There are many other style guides; some are listed on the Wikipedia page: https://en.wikipedia.org/wiki/List_of_style_guides

Your team or organization may also need to develop its own style guide, to standardize the names of your products, features, concepts, user interface elements, and so on.

There are no comments on this comment yet.