Viraji Ogodapola

Nov 25, 2020

5 min read

Good Docs, Anyone?

Here’s where to find them!

Photo by Amador Loureiro on Unsplash
https://images.app.goo.gl/dbgfNPJmFoSaemFdA
Sisyphus rolling a boulder

“Best practice templates and writing instructions for documenting open-source software.”

— The Good Docs Project

That sounds too good to be true, I know. Given our mission, you might be surprised to see the extent of the community already involved in our on-going projects.

  • Templates — best practice templates for frequently used documentation types, including a Base Template for creating your own templates.
    To access our templates (alpha phase), head over to our Github project and look at the progress we’ve been achieving.
  • Information Architecture Guide — that helps you arrive at the type of documentation you need to produce.
  • General guidelines on how to start with documenting an open-source project.
  • Style guides — Standards for writing, formatting and design of documents.