3 ms·
I think the single most important factor of successful technical documentation is to locate documents close to code. Markdown is an excellent choice that strike
by justicezyx 7y ago
I think the single most important factor of successful technical documentation is to locate documents close to code. Markdown is an excellent choice that strikes a nice sweet spot between expressiveness and being code-like (so can be checked in to repo and live together with the code).
Google had done that, and in an exceptional whirlwind by self-motivated engineers who are delighted by having markdown docs in their repo, replaced majority of existing and legacy documentations with markdown files. This thing is called g3doc, and should be well known to people have connections with Google engineers.