3 ms·
Ask HN: What would you improve about the whole “writing docs” experience?
- verdverm 6y agoThe main thing I think most struggle with is what to write and how to organize. To that end, I think https://documentation.divio.com/ https://documentation.divio.com/ is a great resource Smaller things are: - knowing the documentation tools - being able to see modifications locally - using git workflow - keeping in sync with the codebase I'm certainly biased towards a git + markdown -> static site based setup
- detaro 6y agoMixing in-code documentation (i.e. Doxygen) and more general docs is often unelegant (e.g. referencing one from the other). The build chains etc for the in-code tools often are clumsy, making it harder than necessary to e.g. review doc changes between arbitrary versions.