3 ms·
Many people I've worked with in the past have unfortunately shared the sentiment of the author. I think the issue is sustainability of documentation practices.
by gravypod 7y ago
Many people I've worked with in the past have unfortunately shared the sentiment of the author. I think the issue is sustainability of documentation practices. There's a desire path that engineers exhibit when writing docs. We just want to write something and have others be able to read it. Markdown is the lowest barrier of entry because, even without any special characters, my plain text will look "fine" in Markdown. Nothing is truely required.
To me the two most important things are:
1. Docs are tracked with software updates (track in VCS)
2. Enable me to spend less time writing docs and more time writing code
Google documented their experiments with markdown documentation here: https://www.usenix.org/sites/default/files/conference/protected-files/srecon16europe_slides_macnamara.pdf https://www.usenix.org/sites/default/files/conference/protec...