Docs Maintenance After Work

Documents

docs-maintenance-after-work

Docs Maintenance After Work is an Agent Skill for documents published in the J-Pster/Psters_AI_Workflow repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Run standardized post-implementation documentation maintenance and quality checks.

View on GitHub ↗

QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

Open your project in Codex.
Copy and paste the prompt below.
Review files and risks before approving any action.

Prompt to paste

Inspect the Agent Skill at https://github.com/J-Pster/Psters_AI_Workflow/blob/HEAD/plugins/psters-ai-workflow/skills/docs-maintenance-after-work/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/docs-maintenance-after-work, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

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

Run doc-shepherd (always).
Run plan-sync when work maps to an active plan/work-plan context.
Conditionally run specialized doc writers:
- backend-module-doc-writer
- frontend-feature-doc-writer
- lambda-doc-writer
Run pattern-extractor when a reusable pattern emerged.
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:

Specificity — real file/symbol references, no vague text.
State clarity — clear implemented vs planned separation.
Operational usefulness — invariants/gotchas/checklists are concrete.
Contract accuracy — APIs/DTOs/entities/flows match current code.
Cross-doc consistency — no contradictions with critical patterns.
Signal over noise — concise and actionable content.

Constraints

Never skip docs maintenance on work/work-plan flows.
Do not delete protected docs trees.
If uncertain, mark assumptions explicitly and suggest follow-up.