Re:Four kinds of documentation
by chipotle_coyote on Friday October 18, 2019 @11:44AM
(#21292336)
The article talks about four kinds of necessary documentation for large projects: explanation, reference, how-to guides, and tutorials. Auto-generated docs, even when they're very good, only provide one of those -- the reference.
Even if you have great inline documentation that can be turned into a great external reference document, you need separate documentation.
Even if you have great inline documentation that can be turned into a great external reference document, you need separate documentation.