docs-maintenance-after-work

Solid

Run standardized post-implementation documentation maintenance and quality checks.

AI & Automation 289 stars 39 forks Updated 2 months ago MIT

Install

View on GitHub

Quality Score: 82/100

Stars 20%
82
Recency 20%
75
Frontmatter 20%
70
Documentation 15%
91
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Docs Maintenance After Work Use this skill after implementation to keep project docs synchronized with reality and prevent drift. ## Trigger conditions - End of `/pwf-work` execution. - End of `/pwf-work-plan` phase execution. ## Core flow 1. Run `doc-shepherd` (always). 2. Run `plan-sync` when work maps to an active plan/work-plan context. 3. Conditionally run specialized doc writers: - `backend-module-doc-writer` - `frontend-feature-doc-writer` - `lambda-doc-writer` 4. Run `pattern-extractor` when a reusable pattern emerged. 5. Apply documentation quality gate. ## Agent paths - `doc-shepherd` -> `agents/docs/doc-shepherd.md` - `plan-sync` -> `agents/docs/plan-sync.md` - `backend-module-doc-writer` -> `agents/docs/backend-module-doc-writer.md` - `frontend-feature-doc-writer` -> `agents/docs/frontend-feature-doc-writer.md` - `lambda-doc-writer` -> `agents/docs/lambda-doc-writer.md` - `pattern-extractor` -> `agents/docs/pattern-extractor.md` ## Inputs required for doc agents - `diff` — relevant git diff for implementation scope - `changed_files` — modified/created/deleted file list - `work_summary` — short implementation summary ## Documentation quality gate Before claiming completion: 1. **Specificity** — real file/symbol references, no vague text. 2. **State clarity** — clear implemented vs planned separation. 3. **Operational usefulness** — invariants/gotchas/checklists are concrete. 4. **Contract accuracy** — APIs/DTOs/entities/flows match current co...

Details

Author
J-Pster
Repository
J-Pster/Psters_AI_Workflow
Created
2 months ago
Last Updated
2 months ago
Language
JavaScript
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category