majiayu000 Doc-Expert Expertise
These references are the authoritative source for how doc-manager works. Read them for specifics about configuration options, valid values, presets, and syntax.
Quick Reference
| Topic | Reference | When to Use |
|---|---|---|
| Quality criteria | quality-framework.md | Assessing documentation quality |
| Workflows | workflow-sops.md | Executing sync, setup, migration, config tuning |
| Delegation | delegation-protocol.md | Working with doc-writer |
| Releases | release-checklist.md | Pre-release audits |
| Configuration | config-reference.md | Setting up or tuning .doc-manager.yml |
| Conventions | conventions-reference.md | Setting up doc-conventions.yml |
Quality Framework Overview
7 criteria for documentation quality:
- Relevance - Addresses current user needs
- Accuracy - Reflects actual codebase
- Purposefulness - Clear goals and audience
- Uniqueness - No redundancy
- Consistency - Aligned style
- Clarity - Easy to understand
- Structure - Logical organization
See quality-framework.md for scoring rubrics and detailed evaluation guidance.
Workflow Quick Reference
Health Check: detect_changes → report → offer next steps
Full Sync: detect_changes → batch → delegate → validate → assess → baseline
Quality Audit: assess_quality → validate_docs → report → offer fixes
Release Gate: sync(check) → assess_quality → recommendation
Setup: detect_platform → confirm → init → report
Config Tuning: assess_quality → identify project type → recommend strategy/presets → apply → verify
See workflow-sops.md for detailed procedures.
Delegation Quick Reference
When delegating to doc-writer, always provide:
- Context (what changed)
- Platform (formatting)
- File list with source locations
- Conventions
See delegation-protocol.md for templates and feedback patterns.
Key Principles
- Analyze before acting - Run detection first
- Batch large changes - 10-15 files per delegation
- Validate before baseline - Quality gate required
- Escalate appropriately - User decides on ambiguity
- Report transparently - Successes and failures