Skills Guide

Sync Documentation with Code

VerifiedSafe

Updates docstrings to match code signatures and logic, and synchronizes documentation files (README.md, docs/) with implementation changes. Checks both English and Japanese documentation directories for references. Helps maintain accurate and bilingual documentation alongside code evolution.

Download and use
Sby Skills Guide Bot
DocumentationIntermediate
6/2/2026
Claude CodeCursorWindsurfCopilotCodex
#documentation#sync#docstrings#localization#sphinx

Recommended for

Claude CodeCursorCopilotAuto documentationWindsurfCodex

Automated summary

This skill updates documentation (docstrings and .md files) to match code changes.

Strengths

  • Handles both English and Japanese documentation simultaneously.
  • Supports NumPy and Google style docstrings.
  • Verifies parameter, return type, and exception consistency.

Limitations

  • Requires initial setup of documentation formats.
  • Does not automatically detect code changes; user must specify them.
When to use it

When you have modified code and need to synchronize the corresponding documentation across multiple languages.

When not to use it

When generating brand new documentation from scratch or for purely conceptual files.

Security analysis

Safe
Quality score85/100

The skill only instructs reading and writing documentation files; no destructive commands, network activity, or obfuscated code are present.

No concerns found

How this analysis is made

Examples

Update docstrings for new parameters
Update the docstring of function 'calculate_interest' to include the new 'rate' parameter and its type, following the NumPy style used in the project.
Sync Japanese and English docs after API change
I changed the 'get_user' method signature. Please update both docs/reference/en/api.rst and docs/reference/ja/api.rst to reflect the new parameters.

name: sync_docs description: ソースコードの実装に合わせてドキュメント (docstring, *.md) を更新する

Sync Documentation

This skill ensures that the documentation is in sync with the actual code implementation.

Instructions

  1. Update Docstrings:

    • Read the target source code.
    • Check if parameters, return types, and exceptions in the docstring match the signature and logic.
    • Update the docstring using the standard format (NumPy or Google style, matching the project).

  2. Update Documentation Files:

    • Check docs/ or README.md for references to the changed code.
    • Crucial: Check both English (docs/reference/en/) and Japanese (docs/reference/ja/) documentation directories.
    • Update tutorials or API references if the usage has changed.
    • If a new feature was added, ensure it is mentioned in the appropriate section in both languages.

  3. Verify:

    • If possible, run the build_docs skill to ensure no syntax errors were introduced in ReStructuredText or Markdown.

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/sync-documentation-with-code-mm5t8c1a/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/sync-documentation-with-code-mm5t8c1a' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/sync-documentation-with-code-mm5t8c1a/download' --output '.skill-downloads/sync-documentation-with-code-mm5t8c1a/SKILL.md.part' && mv '.skill-downloads/sync-documentation-with-code-mm5t8c1a/SKILL.md.part' '.skill-downloads/sync-documentation-with-code-mm5t8c1a/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

This file does not provide a usable name/description header for this native procedure. It remains available to download and inspect; use the manual method below.

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/sync-documentation-with-code-mm5t8c1a/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills

Supabase Docs Authoring

Documentation

Write, edit, and review Supabase documentation content including guides, tutorials, reference docs, and partials. Follow style guides and MDX/TOML validation rules.

Claude CodeintermediateSafe 108,544
Skills Guide Bot

Create Architecture Decision Record

Documentation

Create a new Architecture Decision Record with sequential numbering, register it in the AgentDB graph, and link related ADRs.

Claude CodeintermediateSafe 69,659
Skills Guide Bot

Plan update with deep research

Documentation

Updates a plan document by launching parallel subagents to analyze a topic across all compiler passes, then consolidates findings into the plan doc.

Claude CodeadvancedSafe 248,015
Skills Guide Bot