Governance Overview
Standards and processes for maintaining PhenoDocs.
Quality Standards
| Metric | Target | Measurement |
|---|---|---|
| Broken Links | 0% | Link checker (weekly) |
| Build Success | 100% | CI pipeline |
| Response Time | < 3s | Lighthouse audit |
| Accessibility | 100% | axe-core tests |
Review Workflow
All reviewable changes follow this fixed sequence:
text
Draft → Auto-Validation → Review → Approval → Publish
│ │ │ │ │
│ │ │ │ └─ Deploy to production
│ │ │ └─ Approve content
│ │ └─ Technical review
│ └─ Link check, build check
└─ Initial creation1
2
3
4
5
6
7
2
3
4
5
6
7
Stacked PR and Release Ops Governance
- Stacked PR and Release Governance
- Branching and Release Channels
- WBS and DAG Rules
- PR Stack Template
- Merge Scenarios
- Release Matrix Template
Roles
Documentation Lead
- Strategy and governance
- Release coordination
- Quality audits
Maintainers
- Domain expertise
- Quality control
- Timely updates
Contributors
- Content creation
- Follow guidelines
- PR reviews
Reviewers
- Accuracy verification
- Feedback
Adding Projects
Addition Criteria
- Active project — Has regular commits
- Proper structure — Follows doc taxonomy
- Frontmatter — All docs have required fields
- Owner — Designated maintainer
Addition Process
- Proposal — Open issue requesting addition
- Review — Docs lead reviews structure
- Integration — Add to HubGenerator
- Verification — Test build and navigation
- Launch — Merge and announce
Removing Projects
Removal Criteria
- Abandoned — No commits > 6 months
- Archived — Project archived
- Requested — Owner requests removal
Removal Process
- Notice — 30 day warning
- Archive — Move to /archive/
- Remove — Remove from HubGenerator
- Update — Regenerate hub
Versioning
PhenoDocs follows semantic versioning:
text
MAJOR.MINOR.PATCH
│ │ │
│ │ └─ Bug fixes
│ └─ New features (backward compatible)
└─ Breaking changes1
2
3
4
5
2
3
4
5
Release Schedule
- Patch: As needed
- Minor: Monthly
- Major: As needed (deprecation notice 90 days)
Security
Content Security
- Review all user-generated links
- Sanitize markdown
- No executable content
Access Control
- Write: Maintainers only
- Review: Contributors
- Read: Public
Data Protection
- No PII in docs
- No credentials in docs
- Regular audits
Compliance
Accessibility (WCAG 2.1 AA)
- Alt text for images
- Proper heading hierarchy
- Color contrast
- Keyboard navigation
Licensing
- All content: MIT or project license
- Dependencies: Compatible licenses
Monitoring
Health Checks
| Check | Frequency | Alert |
|---|---|---|
| Build status | Every commit | Yes |
| Link validity | Weekly | Yes |
| Lighthouse score | Monthly | No |
| Accessibility | Monthly | No |
Metrics
- Page views
- Search queries
- Build time
- Error rate
Incident Response
Broken Build
- Detect — CI failure notification
- Investigate — Check recent changes
- Fix — Revert or patch
- Verify — Confirm build passes
- Document — Update if needed
Broken Links
- Detect — Weekly link check
- Assess — Internal vs external
- Fix — Update or remove
- Verify — Re-check
Continuous Improvement
Retrospectives
- Quarterly doc health review
- Identify gaps
- Plan improvements
Feedback
- Issue tracker
- Discussion board
- Office hours (monthly)
Contact
- Documentation Lead: @doc-lead
- Emergency: #docs-emergency (Slack)
- General: #docs (Slack)