Skill

project-docs

Guide for creating and maintaining project documentation (README, guides, API specs). Emphasizes doc/code synchronization, consistency checks, and use of the docs-excellence-architect subagent.

Install

npx claudepluginhub s-hiraoku/synapse-a2a --plugin synapse-a2a

Tool Access

This skill uses the workspace's default tool permissions.

Preview

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

SKILL.md

Similar Skills

cache-components

Guides Next.js Cache Components and Partial Prerendering (PPR) with cacheComponents enabled. Implements 'use cache', cacheLife(), cacheTag(), revalidateTag(), static/dynamic optimization, and cache debugging.

cache-components

139.2k

mcp-builder

9 files

Guides building MCP servers enabling LLMs to interact with external services via tools. Covers best practices, TypeScript/Node (MCP SDK), Python (FastMCP).

anthropics-skills-13

124.2k

canvas-design

20 files

Generates original PNG/PDF visual art via design philosophy manifestos for posters, graphics, and static designs on user request.

anthropics-skills-13

124.2k

Stats

Parent Repo Stars2

Parent Repo Forks0

Last CommitFeb 11, 2026

Used By3 plugins

Actions

View Source View Plugin View on GitHub View 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

Identify the code changes and their user-visible effects.

Locate the canonical docs (README vs guides vs references).

Update docs with minimal churn, matching existing style.

Cross-check examples against current CLI help / code.

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.

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

Identify the code changes and their user-visible effects.
Locate the canonical docs (README vs guides vs references).
Update docs with minimal churn, matching existing style.
Cross-check examples against current CLI help / code.
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.