Re:A Framework for Writing Better Documentation
by bigiain on Tuesday February 02, 2021 @08:54PM
(#26009687)
> Mostly I think that these things probably belong outside the scheme
Yeah, I think somethings count as "meta documentation" and are "documentation about the documentation" instead of the actual documentation.
"contribution guides" to me are definitely that, "introductions" are mostly that. I reckon licenses are probably "meta documentation" too (since they'll also be in the source code). "release notes" are a bit of a grey area in my head (I'd consider at least major version update release notes and any depreciation/removal of features to be "part of the doco".
Yeah, I think somethings count as "meta documentation" and are "documentation about the documentation" instead of the actual documentation.
"contribution guides" to me are definitely that, "introductions" are mostly that. I reckon licenses are probably "meta documentation" too (since they'll also be in the source code). "release notes" are a bit of a grey area in my head (I'd consider at least major version update release notes and any depreciation/removal of features to be "part of the doco".