| name | docs-maintain |
| description | Check documentation sync and auto-update doc artifacts. Combines sync checking
(template-instance validation) with update automation (index regeneration,
cross-doc dependencies, archive verification).
|
| metadata | {"short-description":"Check doc sync and auto-update doc artifacts"} |
Document Version: 1.0
Last Updated: 2026-02-14
Status: ACTIVE
Documentation Maintenance
Unified skill for checking doc sync and updating doc artifacts.
When NOT to Use
- When the task doesn't match this skill's scope -- check related skills
- When a more specialized skill exists for the specific task
Usage
/docs-maintain # Run both check + update
/docs-maintain --check # Check only (no changes)
/docs-maintain --update # Update only (regenerate + fix)
Check Mode (from docs-sync)
Validate template-instance synchronization.
Execution
npm run docs:sync-check
What It Checks
- Template-derived documents are properly synchronized
- No placeholder content remains (
[e.g., ...], [X], [TODO], etc.)
- All relative links point to existing files
- Sync dates are recent (<90 days)
Exit Codes
- 0: All documents synced
- 1: Sync issues found
- 2: Error during check
Update Mode (from docs-update)
Auto-update documentation artifacts after file changes.
Execution
npm run docs:index && git add DOCUMENTATION_INDEX.md
What It Does
- Regenerate Documentation Index - runs
npm run docs:index to update
DOCUMENTATION_INDEX.md if applicable
- Check Cross-Document Dependencies - reviews
docs/DOCUMENT_DEPENDENCIES.md for affected triggers if it exists
- Verify Archive Requirements - checks moved docs have README.md in archive
folders
- Suggest Updates - lists documents referencing moved/deleted files
When to Use
- After creating, moving, or deleting markdown files
- When pre-commit blocks due to DOCUMENTATION_INDEX.md not staged
- Before multi-AI audits (ensure audit plans are synced)
- After updating templates (verify instances were updated)
- After archiving documents
Related
DOCUMENTATION_INDEX.md - Auto-generated doc index (if applicable)
docs/DOCUMENT_DEPENDENCIES.md - Cross-doc triggers and sync protocols (if
applicable)
- Pre-commit hook - Doc index enforcement
Version History
| Version | Date | Description |
|---|
| 1.0 | 2026-02-25 | Initial implementation |