Brief review of internal developer documentation style guide
- September 22, 2017
- Posted by: Rahul Karn
- Category: Technical writing
Developer documentation Style Guide
In this blog post is for technical writers involved in writing internal developer documentations. In this, you will learn brief comparison of different style guides (Google, Atlassian, and SalesForce).
Style guide for technical writing It’s the first thing a newcomer needs to study to understand and track the changes in a project. A bad documentation is worse than no documentation at all.
Many companies have their own internal developer documentation style guide to write documentation error-free and absolutely clear to prevent any kind of ambiguity but, when they come across external contributors it becomes tough to understand and change the style guide into its own format.
Google is releasing its internal developer documentation style guide. This can quite literally guide your documentation, giving you a great starting point and keeping things consistent.
If you want to follow Google's style guide for your project, you can simply access it here.
In order to better support external contributors to open source projects such as Kubernets, Amp, or Dart, recently Google has released its own internal documentation style guide.
- Being too cutesy
- . Placeholder phrases like ‘please note’
- . Choppy or long-winded sentences
- . Starting all sentences with the same phrase
- . Current pop-culture references
- . Jokes at the expense of customers, competitors or anyone else.
Few more such as Atlassian, WordPress, and Salesforce also released their internal style guide to optimize consistency across developer documentation.
A glimpse of highlights of these style guides is given here to make documentation an easy and accessible task for the newcomers and external contributors.
Salesforce’s guide has the following sections:
- For complete guide visit https://developer.salesforce.com/docs/atlas.en-us.salesforce_pubs_style_guide.meta/salesforce_pubs_style_guide/overview.htm