16 ms·
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 f
by austincheney 8y ago
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.
- tbarn 8y agoThis 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/ https://stoplight.io/). There will almost always be docs you need to update manually though.