For the open source projects, the documentation holds an important and key importance. Like, if new developers are about to join the team for future work or they are going to completely take on things, it will be quite difficult for them to understand things.Documentations are always really important. Sometime it’s good to have no documentation instead of having it because a developer has prepared a really bad one, and that frustrates and disappoints even more. That’s a reason why Google this week has opened up its own developer-documentation style guide.
New Developer-Documentation Style:
The new style guide which is used by Google for the internal documentation writing of its own new projects is like the Kubernetes and Dart.
“Add Capture 1 Image here”
The guide itself includes everything from a word list to ensure the consistent spelling of our industry jargon (it’s “data center,” not “data-center,” for example), how to use hyphens (and when not to), why you should use active voice and other basics. What developers may care more about, though, is that the guide also talks about how to write good API code comments and how to best document command-line syntax.
Other companies such as Atlassian, WordPress and Salesforce had also published their documentation writing styles public. A few of them are really in-depth guide styles just like the Google when it comes to the basics.
“Add Capture 2 Image here”
