...
All spaces have a clear owner (listed in the top-level doc whenever possible) to manage updates, permissions, and archiving.
We use 3 large “types” of documentation, designed for different purposes:
Reference/system/end-user documentation - The documentation we’re most familiar with: docs that explain how to do something, or provide helpful reference.
Team documentation - Landing pages for organizational groups of people, including contact information and links to docs/projects.
Project documentation - Pages for organizing projects, particularly across-theme/org. These will act as source-of-truth and points of entry for finding out about a project.
Some system for archiving/marking deprecated pagesArchive more. Anyone stumbling across an out-of-date page should be empowered to update or archive it. Alternatively, they may request update/archive using the following signals (for spaces with more restrictive archiving rights):
#updates-needed - Propose adding this new tag to help space owners find out-of-date pages.
#archive - Propose adding this new tag to help space owners find pages that should be archived/deleted.
Investigate tooling/watching for this tag for space owners so they can be notified about these.
Rationale:
The highest level goals are organizational and doc clarity & helpfulness. Establishing clear owners helps make it clear who should be updating/making decisions about a doc.
Using different documentation patterns for reference/team/projects allow us to scope documentation in a way we scope our thinking and organization in edX already, making it easier to navigate the org.
We also need a way of pruning out of date info. Using tags helps space owners identify out of date pages, which we empower them to actively archive.
Organizational Proposals
...