27 lines
1.4 KiB
Markdown
27 lines
1.4 KiB
Markdown
|
# Documentation Hub
|
||
|
|
|
||
|
|
Use this hub when the task changes how people understand, adopt, operate, or maintain the product.
|
||
|
|
|
||
|
|
If [DEPLOYMENT-PROFILE.md](../DEPLOYMENT-PROFILE.md) contains documentation defaults, apply those preferences before falling back to the generic routing in this hub.
|
||
|
|
|
||
|
|
## When To Use
|
||
|
|
|
||
|
|
- Write or update technical documentation
|
||
|
|
- Improve onboarding or contributor guidance
|
||
|
|
- Create release notes or change summaries
|
||
|
|
- Align docs with code or product changes
|
||
|
|
|
||
|
|
## Skill Routing
|
||
|
|
|
||
|
|
- [Architecture Decision Records](../skills/documentation/architecture-decision-records.md) for capturing meaningful technical choices, tradeoffs, and why a direction was selected
|
||
|
|
- [Technical Documentation](../skills/documentation/technical-docs.md) for architecture, APIs, workflows, operational guidance, and usage docs
|
||
|
|
- [Onboarding Documentation](../skills/documentation/onboarding-docs.md) for setup guides, contributor onboarding, first-run experience, and internal enablement
|
||
|
|
- [Release and Change Summary](../skills/software/release-change-summary.md) for release notes, changelog writing, and rollout explanations
|
||
|
|
|
||
|
|
## Common Combinations
|
||
|
|
|
||
|
|
- New feature: technical docs + release/change summary
|
||
|
|
- Developer experience improvement: onboarding docs + technical docs
|
||
|
|
- Product launch: release/change summary + messaging/positioning + marketing content
|
||
|
|
- Long-lived architecture change: architecture and system design + architecture decision records + technical docs
|