Writing Documentation in Markdown and Managing Under docs/

Tadashi Shigeoka ·  Tue, December 8, 2020

I’ll introduce my approach of writing documentation in Markdown and managing it under the docs/ directory.

docs/spec.md

Background: Writing Documentation in Markdown and Managing with Git

I write documentation like specifications in Markdown and manage them with git under the docs/ directory, like:

docs/spec.md

This is just an article introducing this approach.

Examples of Document Management Under docs/

That’s all from the Gemba on wanting to manage documentation for each development project by creating a docs/ directory in the git repository managing source code and writing in Markdown.