We release several times a week, and keeping the documentation accurate is becoming increasingly difficult. Code changes go through a clear review process, but documentation updates are less consistent. For example, a parameter or response field may change, the release ships, and only weeks later do we discover that examples still describe the old behavior. We've tried adding documentation to the pull request checklist, but engineers often aren't sure which pages are affected. What processes, tooling, or workflows have helped your team keep documentation current?
1 Answer
The publishing pipeline needs to be coupled to the release pipeline. If documentation is built or deployed separately, establish a rule that the release cannot go out until the matching docs have been reviewed and published. Even a lightweight gate is useful, as long as it applies to public behavior changes rather than forcing unnecessary edits for every internal code change.
Related Questions
Can't Load PhpMyadmin On After Server Update
Redirect www to non-www in Apache Conf
How To Check If Your SSL Cert Is SHA 1
Windows TrackPad Gestures