mcpField
P
project-docs

project-docs

github.com/s-hiraokuDevelopment1978 installsUpdated 4w ago
Repository

About project-docs

project-docs is a skill for keeping project documentation accurate and aligned with code changes. It guides developers through locating canonical docs, making focused edits, and checking examples and terminology.

Key features

  1. 01Identify user-visible code changes
  2. 02Locate canonical documentation
  3. 03Update docs with minimal changes
  4. 04Verify examples against CLI and code
  5. 05Check terminology and configuration consistency

Use cases

  1. 01Document a new CLI flag or configuration change
  2. 02Update API or protocol references
  3. 03Review docs after a behavior change

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/s-hiraoku/synapse-a2a --skill project-docs

After installing, type/project-docsin Claude Code to confirm it loaded.

Details

From the project README

Project Docs

This skill helps you keep documentation correct, minimal, and aligned with the codebase.

What To Document

  • User-facing behavior changes
  • New CLI flags, environment variables, configuration changes
  • Protocol/API changes, request/response shapes
  • Operational guidance (troubleshooting, limitations, safety workflows)

Doc Update Workflow

  1. Identify the code changes and their user-visible effects.
  2. Locate the canonical docs (README vs guides vs references).
  3. Update docs with minimal churn, matching existing style.
  4. Cross-check examples against current CLI help / code.
  5. Run relevant tests and include them in the update note.

Consistency Checks

  • Option names match actual CLI flags (--help output if available).
  • Defaults are correct and stated once (avoid duplication across docs).
  • Examples are runnable and do not rely on project-private paths.
  • Terminology is consistent across README/guides/references.

Subagent Invocation (docs-excellence-architect)

Use the Task tool to delegate a doc-focused review to a specialized subagent:

  • subagent_type: docs-excellence-architect

Provide:

  • The doc files to touch
  • The code changes that need to be reflected
  • The desired doc structure (where each piece should live)

Example prompt:

Review and update docs for the following changes:
- <change 1>
- <change 2>
Target files:
- README.md
- guides/*.md
- docs/*.md
Constraints:
- Minimal churn, match local style
- Ensure examples are accurate and consistent
Deliverables:
- Proposed edits (diff-style)
- A checklist of what was verified

Maintenance Guidelines

  • Prefer short sections with concrete examples.
  • Avoid repeating the same definition in multiple files.
  • When a doc becomes a reference, move it to a single canonical location and link to it.

Comments

Markdown supported