Identifying outdated doc
Removing this discussion issue from draft.
Adding new documentation
The process for adding new docs to the documentation site is well documented. The first draft of documentation is written by developers or PMs responsible for a feature. Docs are written as part of the development "definition of done." This process typically works extremely well, although occasionally changes are not documented.
Maintaining the content
The maintenance of this content, however, is an outstanding problem. While the content itself is owned by specific groups, I know of no group that regularly reviews the existing documentation to catch outdated information.
When TWs discover outdated information, we can request that it be updated, and we do this frequently. We are not staffed to update it ourselves, however.
This issue discusses how TWs suggest we identify old docs content. We're very interested in creating an epic to update the docs site content, and then develop a process to keep it up to date.
Draft issue discussion
Question: if you needed to identify docs in your area that were technically outdated, how would you go about it?
I'm not thinking about docs that need CTRT (which is almost all of them), but technically outdated:
-
Old versions of third-party software mentioned
-
New ways in GitLab to perform what is perhaps an old task
-
Steps that are now wrong
-
Outdated images
-
New settings or parameters (or other reference-type info) that are not documented or have changed
-
What else would be technically outdated?
I don't think it is as simple as "page that was edited the longest time ago" because maybe the page wasn't updated then.
How would y'all go about it?