Ask HN: What style guides are there for technical documentation?
Do you use one at work? Do you prefer or recommend any? What freely available ones are there?
• 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.
What amounts to genuine tech exchange these days, as it appears to me, are mostly PowerPoint presentations at conferences. The formal docs are man pages, and probably RFCs, the informal docs are some guy's blog or a single blog page. The project's README.md are helpful as well but they conform to the individual and not any style. Serious tech papers conform to scientific and research publication style, and even then style guide has more to do with citations. There's nothing standard and easy to reach for in the business-technology intersection.
My recommendation is to find documentation for an existing system that you find helpful and easy to understand, then use that as an outline for creating your documentation.
Style guides can be great in the right context, but I think focusing on them too much can take away from the most important part of documentation – the content.
Is it the practitioners who will use the technology in the wild? Or do you want to sell your technology to the CTOs and technology scouts? A whole different format and content might be chosen in case you would like to receive a thorough feedback and review of your technology (RFC).