Re:Writing Documentation When You Aren't a Technical Writer
by austincheney on Friday August 24, 2018 @09:38AM
(#17834845)
I found that when I was manually updating documentation I could never keep it perfectly in sync with the code. Now in my open source app the documentation is fully automated and generated as a part of the build process. The interactive documentation covers the app's use in a browser, command line, and static documentation is various formats.
[ Parent
| on HN ]
Re:Writing Documentation When You Aren't a Technical Writer
by tbarn on Friday August 24, 2018 @11:34AM
(#17835556)
This is very closely related to the idea of a single source of truth that good docs built with OpenAPI Specification use, which is what the company I work for is built on top of (https://stoplight.io/). There will almost always be docs you need to update manually though.