Skip to content
docs-sync logo

Docs sync

docs-sync

Keep documentation in sync with code changes across README, docs sites, API docs, runbooks, and configuration. Use when the user asks to update docs, ensure docs match behavior, or prepare docs for a release/PR.

SKILL.md

Full skill instructions

Docs sync

Goal

Update documentation so it matches the current code and is easy for the target audience to follow.

Inputs to ask for (if missing)

  • What changed (feature/​bugfix/​refactor) and who the docs are for.
  • Which docs surfaces matter: README, /​docs, wiki, runbooks, API spec, changelog, onboarding.
  • Any required format/​voice (company style guide, "keep it short", etc.).

Workflow (checklist)

  1. Identify what changed
    • Use the diff to locate impacted areas:
      • git diff --name-only
      • git diff
  2. Inventory docs surfaces in the repo
    • Common locations: README.md, docs/, CONTRIBUTING.md, CHANGELOG.md, openapi.*, schema.graphql, adr/, runbooks/.
    • For Spring: check for generated OpenAPI/​Swagger docs or endpoint annotations.
    • For Next/​TypeScript: check for docs pages, Storybook, or typed API clients.
    • If your repo uses docs/ as the primary doc root, see references/​docs-structure.md for a suggested layout.
  3. Decide what needs updating
    • Ensure docs cover:
      • setup and local dev commands
      • required env vars / config keys
      • API contract changes (request/​response examples)
      • DB migrations and operational steps
      • behavior changes visible to users
    • If the change is an architectural/​behavioral decision, add or update an ADR (use references/​adr-template.md).
  4. Apply edits with minimal churn
    • Prefer small, targeted edits over rewrites.
    • Add examples that are copy/​paste runnable.
    • Keep headings stable to avoid breaking deep links.
    • Use templates in references/ when helpful.
  5. Verify docs are consistent
    • Run the repo's existing doc checks if present (md lint, docs build, site build).
    • At minimum: ensure code fences match the actual commands and file paths, and env var names match the code.

Deliverable

Provide:

  • The list of docs files updated and why.
  • A short "How to verify" section (commands or manual checks).

More skills from majiayu000

xiaohongshu logo
majiayu000/claude-arsenal

xiaohongshu

xiaohongshu

286 148
View
agent-task-conductor logo
majiayu000/claude-skill-registry

agent-task-conductor

Conduct multi-agent task orchestration and workflow coordination.

663 1
View
conductor-setup logo
majiayu000/claude-skill-registry

conductor-setup

Initialize project with Conductor artifacts (product definition,

663 1
View
animation-designer logo
majiayu000/claude-skill-registry

animation-designer

Expert in web animations, transitions, and motion design using Framer Motion and CSS

663 1
View
diagramming logo
majiayu000/claude-skill-registry

diagramming

Creates Mermaid and ASCII diagrams for flowcharts, architecture, ERDs, state machines, mindmaps, and more. Use when user mentions diagram, flowchart, mermaid, ASCII diagram, text diagram, terminal diagram, visualize, C4, mindmap, architecture diagram, sequence diagram, ERD, or needs visual docume...

663 1
View
h3-pg logo
majiayu000/claude-skill-registry-data

h3-pg

PostgreSQL bindings for H3 hexagonal grid system. Use when working with H3 cells in Postgres, including spatial indexing, geometry/geography integration, and raster analysis.

23 1
View
conductor-development logo
majiayu000/claude-skill-registry

conductor-development

Context-Driven Development skill for projects using Conductor. Use this skill when you detect a `conductor/` directory in the project, when working on tasks defined in a `plan.md` file, or when the user asks about tracks, specs, or plans. Automatically applies TDD workflow, tracks task completion...

663 1
View
conductor-status logo
majiayu000/claude-skill-registry

conductor-status

Display project status, active tracks, and next actions

663 1
View
dockerization logo
majiayu000/claude-skill-registry

dockerization

Official Stakpak application containerization standard operating procedure, a step-by-step guidline to properly dockerize applications. This is a rule book curated by the Stakpak Team.

663 1
View

Popular AI tools

Kaiber logo
Video

Kaiber

Generate, edit, and beat-sync AI video with leading models in one workspace.

Paid
View
Vimcal logo
Productivity

Vimcal

The world's fastest calendar for remote work

Free
View

Transform Your Design with AI Designer by ImgCreator.ai

Freemium
View
Akool AI logo
Content & writing

Akool AI

Revolutionizing Video Production with AI-Powered Creativity

Paid
View

Extend an image past the frame and let AI fill the new aspect ratio.

Freemium
View
StarByFace logo
Security

StarByFace

Discover your celebrity doppelgänger with StarByFace!

Free
View
C

ChainClarity explains 700+ crypto whitepapers in plain English, with layered summaries, comparisons, research tools, alerts, and a $4.99 Pro plan.

Freemium
View
Opus Clip logo
Coding & apps

Opus Clip

Opus.ai: Revolutionize Your Web Experience

Free
View