3 ms·
Documentation for a software project should be fairly succinct and should be editable by anyone on the project. Developers are exposed to markdown on a near dai
by ogre_codes 7y ago
Documentation for a software project should be fairly succinct and should be editable by anyone on the project. Developers are exposed to markdown on a near daily basis for other tools like GitHub, StackOverflow, and many other tools.
Markdown is the tool every one of us already know how to use.
> The markdown ecosystem is now riddled with non standard extensions and reminds me the browser ecosystem of y2k
Yet 99% of documentation I've written uses the basic syntax described here: https://daringfireball.net/projects/markdown/syntax https://daringfireball.net/projects/markdown/syntax
Extensions add to that basic set of tools, so even if you are using Github's flavor of markdown, every single developer on your tool is going to be able to read and edit most of your documentation without referring to any reference material.