agentsclimarketplace
Sign in

Maintain project docs

Skill gaelic-ghost/socket/plugins/productivity-skills/skills/maintain-project-docs

Coordinate project documentation maintenance across README.md, CONTRIBUTING.md, AGENTS.md, ACCESSIBILITY.md, and ROADMAP.md by delegating to the owner document skills and auditing cross-document responsibility drift. Use when a repo needs a complete docs sweep, doc-boundary audit, repeated-content cleanup, or a single umbrella pass over project-maintenance documentation.From its SKILL.md

Install
npx -y skills add gaelic-ghost/socket --skill maintain-project-docs

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

  • 6 stars6 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

SKILL.md

4.0 KB, 802 tokens by cl100k_base, as published. Nobody here has run it

Maintain Project Docs

Coordinate a complete project-docs sweep without collapsing the document-specific skills into one oversized workflow.

This skill is the umbrella layer for repository documentation maintenance. It delegates canonical file audits and bounded edits to the owner skills, then checks whether content responsibilities are drifting across files.

Inputs

  • Required: --project-root <path>
  • Required: --run-mode <check-only|apply>
  • Optional: --include <readme,contributing,agents,accessibility,roadmap>
  • Optional: --skip <readme,contributing,agents,accessibility,roadmap>
  • Optional: --collect-source-tickets
  • Optional: --collect-github-issues
  • Optional: --github-repo <owner/repo>

Workflow

  1. Validate the project root and choose the included document workflows.
  2. Run the owner workflows serially in this order: README, CONTRIBUTING, AGENTS, ACCESSIBILITY, ROADMAP.
  3. Pass --collect-source-tickets, --collect-github-issues, and --github-repo only to the roadmap workflow.
  4. In check-only, report each owner workflow's findings plus cross-document responsibility issues.
  5. In apply, let each owner workflow make only its own bounded file edits, then audit the resulting document set again.
  6. Keep any cross-document moves, wording rewrites, or repeated-content cleanup in the main thread unless a future deterministic fixer owns those edits.

Responsibility Boundaries

  • README.md: product overview, status, quick start, usage, and short development pointer.
  • CONTRIBUTING.md: human contributor workflow, setup, development expectations, PR expectations, and communication rules.
  • AGENTS.md: durable agent-facing repo scope, routing, commands, review and delivery rules, and safety boundaries.
  • ACCESSIBILITY.md: accessibility standards, architecture expectations, known gaps, support paths, and verification evidence.
  • ROADMAP.md: milestones, small tickets, TODO/FIXME imports, backlog planning, and notable roadmap history.

When content belongs in another file, report the mismatch instead of copying or rewriting it silently.

Codex Subagent Fit

Use the shared trigger and sandbox policy in docs/maintainers/codex-subagent-guidance.md. This skill is a good fit for repo-docs-auditor, review-packet planning, and broad repo-doc discovery before this skill coordinates owner docs workflows: checking docs for stale commands, comparing roadmap claims against repo evidence, inventorying nested AGENTS.md overrides, and finding cross-document responsibility drift.

Keep apply edits in the main thread. The auditor may return proposed patch-set entries, but the main agent should review them with the user before saving, editing, or applying any documentation edits.

Output Contract

  • Return Markdown plus JSON with:
    • run_context
    • document_order
    • document_reports
    • responsibility_issues
    • fixes_applied
    • post_fix_status
    • errors
  • If there are no issues and no errors, output exactly No findings.

Guardrails

  • Never auto-commit, auto-push, or open a PR.
  • Never invent project claims, commands, accessibility evidence, roadmap scope, or agent policy.
  • Never make broad cross-file rewrites as a side effect of running the umbrella workflow.
  • Do not duplicate detailed rules across README, CONTRIBUTING, AGENTS, ACCESSIBILITY, and ROADMAP just to make each file self-contained.
  • Treat this skill as an orchestrator. The owner document skills keep their own schemas, templates, and bounded apply behavior.

References

  • agents/openai.yaml
  • references/document-boundaries.md
  • references/project-docs-maintenance-automation-prompts.md
  • scripts/maintain_project_docs.py

Keep looking

Skills are one crate of 326,764. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.