About project-docs-maintainer
A documentation-maintenance skill for repository maintainers, with separate modes for skills README audits and roadmap checks or bounded updates. It prioritizes read-only review before edits and defines reporting and file-scope guardrails.
Key features
- 01README maintenance audits
- 02Roadmap validation and normalization
- 03Read-only checks before edits
- 04Bounded, mode-specific updates
- 05Markdown and JSON reports
Use cases
- 01Check a skills repository README for schema issues
- 02Validate a checklist-style ROADMAP.md
- 03Apply reviewed documentation fixes
- 04Confirm status after documentation changes
Install
Copy the command and run it in a terminal.
$
npx skills add https:/ / github.com/ gaelic-ghost/ productivity-skills --skill project-docs-maintainerAfter installing, type/project-docs-maintainerin Claude Code to confirm it loaded.
Bundled files
References and scripts installed along with SKILL.md.
agents/openai.yamlconfig/roadmap-customization.template.yamlreferences/checks-common.mdchecks-js-ts.mdchecks-python.mdchecks-rust.mdchecks-swift.mddiscoverability-rules.mdfix-policies.mdoutput-contract.mdprofile-model.mdroadmap-automation-prompts.mdroadmap-config-schema.mdroadmap-customization.mdsection-schema.mdseed-artifacts.mdskills-readme-maintenance-automation-prompts.mdstyle-rules.mdverification-checklist.mdscripts/roadmap_alignment_maintainer.pyskills_readme_maintenance.pytests/test_roadmap_alignment_maintainer.pytest_skills_readme_maintenance.pyDetails
From the project READMEProject Docs Maintainer
Use one canonical skill entrypoint for documentation maintenance, then choose the matching mode.
Inputs
mode=skills_readme_maintenance- Required:
--workspace <path> - Optional:
--repo-glob <glob>, repeatable--exclude <path>,--apply-fixes
- Required:
mode=roadmap_maintenance- Required:
--project-root <path>,--run-mode <check-only|apply> - Optional:
--roadmap-path <path>
- Required:
- Use canonical mode names in all new prompts.
- Treat
skills_readme_alignmentas compatibility-only.
Workflow
- Pick the canonical
modefrom the user request. - Run the read-only variant first:
skills_readme_maintenance: audit firstroadmap_maintenance:--run-mode check-onlyfirst
- Review findings and keep the fix scope bounded to the selected mode.
- If the user requested edits, run the corresponding bounded write path:
skills_readme_maintenance:--apply-fixesroadmap_maintenance:--run-mode apply
- Re-run the same mode to confirm remaining issues.
- Return the mode-specific Markdown and JSON report shape.
skills_readme_maintenance
- Script:
scripts/skills_readme_maintenance.py - Scope:
README.mdmaintenance for*-skillsrepositories - References:
references/output-contract.mdreferences/section-schema.mdreferences/discoverability-rules.mdreferences/profile-model.md
roadmap_maintenance
- Script:
scripts/roadmap_alignment_maintainer.py - Scope: checklist-style
ROADMAP.mdvalidation, migration, and bounded normalization - References:
references/roadmap-customization.mdreferences/roadmap-config-schema.md
Output Contract
skills_readme_maintenance- Return Markdown plus JSON with:
run_contextrepos_scannedprofile_assignmentsschema_violationscommand_integrity_issuesfixes_appliedpost_fix_statuserrors
- If there are no issues and no errors, output exactly
No findings.
- Return Markdown plus JSON with:
roadmap_maintenance- Return Markdown plus JSON with:
run_contextfindingsapply_actionserrors
- If there are no findings, no apply actions, and no errors, output exactly
No findings.
- Return Markdown plus JSON with:
Guardrails
- Never auto-commit, auto-push, or open a PR.
- Never edit source code, manifests, lockfiles, or CI files.
- In
skills_readme_maintenance, keep edits bounded toREADME.mdand explicitly approved snippet insertions intoAGENTS.md. - In
roadmap_maintenance,applymode may edit only the targetROADMAP.md. - Keep deprecated aliases out of the main path and mention them only when handling legacy prompts.
References
references/output-contract.mdreferences/skills-readme-maintenance-automation-prompts.mdreferences/roadmap-automation-prompts.mdreferences/profile-model.mdreferences/section-schema.mdreferences/discoverability-rules.mdreferences/fix-policies.mdreferences/roadmap-customization.mdreferences/roadmap-config-schema.md
Comments
Markdown supported