Documentation Ownership
Ownership expectations
- Every documentation change should be reviewed by a content owner or delegated reviewer.
- High-impact pages should have at least one domain reviewer.
- Significant behavioral changes should be reviewed with platform/DevX stakeholders.
Review depth guidance:
- Minor edits: single owner review.
- Structural or process changes: owner + domain reviewer.
- High-impact operational/security guidance: owner + domain + platform reviewer.
Ownership model
Each page should have a named owner (team or role) responsible for:
- Accuracy.
- Timely updates.
- Responding to feedback and issues.
Suggested ownership model:
- One accountable owner per page.
- At least one backup maintainer per content area.
- Ownership listed in metadata and team records.
Recommended ownership fields:
ownerorowner_slacklast_reviewed_onreview_in
Shared responsibility model
Documentation quality and availability are a shared responsibility between the Developer Portal team and the content owner team.
Developer Portal team responsibilities
- Maintain ingestion, build, and publishing pipelines for supported documentation formats.
- Keep portal navigation, routing, and search infrastructure healthy.
- Communicate platform-level ingestion or publishing changes that affect contributors.
- Provide support and triage for portal-level failures.
Content owner responsibilities
- Keep content accurate, complete, and up to date.
- Maintain page metadata, ownership details, and review cadence.
- Validate links, examples, and structure before merge.
- Respond to user feedback and fix content defects quickly.
Joint responsibilities
- Coordinate rollout for high-impact or structural content changes.
- Confirm post-merge visibility and correctness in the published portal.
- Agree migration and deprecation paths for retired content.
Update and deprecation lifecycle
When content changes:
- Update page details and examples.
- Update review metadata.
- Confirm any related links and references.
When content is deprecated:
- Mark as deprecated with guidance to replacement content.
- Keep migration path clear for users.
- Remove only after replacement has been stable and communicated.
flowchart TB
A[Content created] --> B[Owner assigned]
B --> C[Periodic review due]
C --> D{Still accurate?}
D -->|Yes| E[Update review date]
D -->|No| F[Revise or deprecate]
F --> G[Publish replacement or migration guidance]
G --> H[Retire old content]
Operational guidance for maintainers
- Maintain a regular review cadence.
- Track recurring user questions and feed them into docs updates.
- Prefer small, frequent updates over large infrequent rewrites.
This page was last reviewed on 9 July 2026.
It needs to be reviewed again on 9 January 2027
by the page owner #developer-experience-alerts
.
This page was set to be reviewed before 9 January 2027
by the page owner #developer-experience-alerts.
This might mean the content is out of date.