New: 98,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

A2ui Doc Sync Check

by a2ui-project in a2ui-project/a2ui

Auditing codebase implementations for synchronization drift with the user documentation, readmes, and code comments.

Apache-2.0Auto-check passedDevelopment

Install A2ui Doc Sync Check

skills CLI
$ npx skills add a2ui-project/a2ui --skill a2ui-doc-sync-check -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install a2ui-project/a2ui a2ui-doc-sync-check --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/a2ui-project/a2ui.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/a2ui-doc-sync-check .claude/skills/a2ui-doc-sync-check && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
a2ui-doc-sync-check
GitHub stars
17k
Token cost
~824 tokens
SKILL.md length
416 words
Files
1
Skills in repo
20
Repo updated
First seen
Licence
Apache-2.0

At a glance

Auditing codebase implementations for synchronization drift with the user documentation, readmes, and code comments.

  • Works in 7 steps: Locate Documentation and Readmes → Audit Readme Commands and Configs → Audit Code-vs-Docs Public API and Settings → …
  • Tasks that involve Technical documentation
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

A2ui Doc Sync Check is an agent skill from a2ui-project/a2ui. Auditing codebase implementations for synchronization drift with the user documentation, readmes, and code comments.

Its SKILL.md is about 820 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical documentation. The licence is Apache-2.0.

When your agent uses it

  • Tasks that involve Technical documentation

Example prompts

  • “/a2ui-doc-sync-check”

Workflow steps

7 steps, taken from the first numbered list in SKILL.md.

  1. Locate Documentation and Readmes
  2. Audit Readme Commands and Configs
  3. Audit Code-vs-Docs Public API and Settings
  4. Audit Inline Comments and Docstrings
  5. Links and Duplicates
  6. Conciseness and Clarity
  7. Format the Report

What it can do on your machine

Read from SKILL.md and the folder at commit db43065. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

A2ui Doc Sync Check loads about 824 tokens when it runs. Until then it costs about 34 tokens; SKILL.md has 416 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~34
When it runs · the whole SKILL.md, loaded when a task matches
~824

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from a2ui-project/a2ui at commit db43065, republished under its Apache-2.0 licence (© a2ui-project). 416 words, ~824 tokens.

Download SKILL.mdSave it as .claude/skills/a2ui-doc-sync-check/SKILL.md (or your agent's skills folder).
name
a2ui-doc-sync-check
description
Auditing codebase implementations for synchronization drift with the user documentation, readmes, and code comments.

A2UI Code and Documentation Synchronization Check Skill

This skill guides the process of auditing concrete codebase implementations to verify that they are synchronized with their respective documentation files, codebase READMEs, and inline code comments/docstrings.

Instructions

  1. Locate Documentation and Readmes:

    • Find all user guides, tutorials, and specifications under docs/ and specification/.
    • Find the README.md files in each codebase directory.

  2. Audit Readme Commands and Configs:

    • For each codebase directory, parse the README.md to extract setup commands, dependencies, build/test commands, and directory layouts.
    • Cross-reference these details with the codebase's project files (e.g. package.json, pyproject.toml, pubspec.yaml, Package.swift).
    • If any command listed in the readme is invalid, deprecated, or has wrong arguments, list it as a discrepancy.

  3. Audit Code-vs-Docs Public API and Settings:

    • Make sure the glossary is respected. Verify that terms used in code, documentation and blueprints are consistent with the glossary. If you find deviations, suggest fixes. If you see an important term is used in documentation and/or API, but is missing from the glossary, suggest an update for the glossary.
    • Inspect the codebase's public API entrypoints (classes, interfaces, types, methods).
    • Compare them against any descriptions, structural maps, or code snippets in the docs/ folder.
    • Look for renamed classes, changed signatures, or removed options that are still described in the docs.
    • If the codebase exposes new settings or flags that are undocumented in docs/ or the spec guides, log them as missing documentation.

  4. Audit Inline Comments and Docstrings:

    • Audit inline comments and docstrings (e.g. JSDoc in TS, docstrings in Python, triple-slash comments in Dart/Swift) for public APIs.
    • Flag any mismatch where code parameter names, types, return behaviors, or exceptions thrown deviate from what the docstring claims.

  5. Links and Duplicates:

    • When an artifact (code, document, issue, PR, comment and so on) is referenced, make sure it has a link.
    • When a glossary term is used - link the first occurrence of the term to the glossary entry if it exists.
    • Make sure there is no duplications of content. If you find some, delete the duplicate and leave a reference.

  6. Conciseness and Clarity:

    • Verify that documentation and code comments follow the natural-writing skill, and flag text that breaks its rules.

  7. Format the Report:

    • Build a Markdown report summarizing the findings:
      • Table of audited directories.
      • Documentation Drift: Mismatches between documentation guides (docs/) and codebase implementations.
      • Readme Errors: Invalid setup, compile, or test commands found in README.md files.
      • Docstring Mismatches: Outdated parameter names or behaviors described in inline comments.
    • Return this Markdown report as your final response.

© a2ui-project, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .agents/skills/a2ui-doc-sync-check of a2ui-project/a2ui.

Open the folder on GitHubat commit db43065

Compare with similar skills

A2ui Doc Sync Check next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

A2ui Doc Sync Check compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
A2ui Doc Sync Check this skilla2ui-project/a2ui17k—~824Automated safety check: PassApache-2.0
Diagram Designcathrynlavery/diagram-design45k1 repos~7.5kAutomated safety check: PassMIT
Simple Englishmoeru-ai/airi50k2 repos~4.6kAutomated safety check: PassMIT
Get API Docs with chubandrewyng/context-hub14k2 repos~775Automated safety check: PassMIT
Doc SyncJetBrains/ideavim10k2 repos~2.6kAutomated safety check: PassMIT
Mailspring App ScreenshotsFoundry376/Mailspring18k—~1.5kAutomated safety check: PassGPL-3.0

Similar skills

  • Diagram Design

    cathrynlavery/diagram-design

    Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.

    45k GitHub starsUsed in 1 repo~7.5k tokens
    DevelopmentAuto-check passed

  • Simple English

    moeru-ai/airi

    Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.

    50k GitHub starsUsed in 2 repos~4.6k tokens
    DevelopmentAuto-check passed

  • Get API Docs with chub

    andrewyng/context-hub

    Fetches current documentation for third-party APIs and SDKs with the chub CLI before the agent writes code against them, instead of relying on remembered API shapes.

    14k GitHub starsUsed in 2 repos~775 tokens
    DevelopmentAuto-check passed

  • Doc Sync

    JetBrains/ideavim

    Official

    Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.

    10k GitHub starsUsed in 2 repos~2.6k tokens
    DevelopmentAuto-check passed

  • Mailspring App Screenshots

    Foundry376/Mailspring

    Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.

    18k GitHub stars~1.5k tokensUpdated today
    DevelopmentAuto-check passed

  • Draw.io Diagram Studio

    Agents365-ai/drawio-skill

    Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.

    10k GitHub stars~2.4k tokensUpdated 6 days ago
    DevelopmentAuto-check: notes

More from a2ui-project/a2ui

All 20 skills in this repo

  • A2ui Remediate Problem

    a2ui-project/a2ui

    Remediates a specific recommendation from an A2UI compliance report issue, or resolves any general GitHub issue, by inspecting context, implementing minimal targeted fixes, verifying tests, creating…

    17k GitHub stars~1.5k tokensUpdated today
    Auto-check passed

  • A2ui Issue Triage

    a2ui-project/a2ui

    Automates the triage of GitHub issues in the A2UI repository.

    17k GitHub stars~1.5k tokensUpdated today
    Auto-check passed

  • A2ui Audit

    a2ui-project/a2ui

    Main coordination skill to run the blueprint compliance, documentation synchronization, and test quality audits, posting the combined results as a labeled GitHub issue.

    17k GitHub stars~1.6k tokensUpdated today
    Auto-check passed

  • Inference Format Optimizer

    a2ui-project/a2ui

    Iterative benchmarking, evaluation, and algorithmic optimization of alternative A2UI inference formats (such as Express, Atom, and Elemental).

    17k GitHub stars~985 tokensUpdated today
    Auto-check passed

  • A2ui Generate Pydantic Models

    a2ui-project/a2ui

    Automated generator for strongly typed Pydantic v2 data models and basic catalogs across any A2UI protocol version (v0.8, v0.9, v0.9.1, v1.0, etc.).

    17k GitHub stars~2.3k tokensUpdated today
    Auto-check passed

  • A2ui Python Development

    a2ui-project/a2ui

    Grounding, architectural standards, Python best practices, package facade conventions, testing, and verification workflows for developing any Python code across the entire A2UI repository (core…

    17k GitHub stars~2.4k tokensUpdated today
    Auto-check passed

Categories

Questions about A2ui Doc Sync Check

What does A2ui Doc Sync Check do?

Auditing codebase implementations for synchronization drift with the user documentation, readmes, and code comments. A2ui Doc Sync Check is an agent skill from a2ui-project/a2ui. Auditing codebase implementations for synchronization drift with the user documentation, readmes, and code comments.

When should I use A2ui Doc Sync Check?

A2ui Doc Sync Check fits situations like: tasks that involve Technical documentation.

How do I install A2ui Doc Sync Check in Claude Code?

Run `npx skills add a2ui-project/a2ui --skill a2ui-doc-sync-check -a claude-code`. Or copy the skill folder (.agents/skills/a2ui-doc-sync-check in a2ui-project/a2ui) into .claude/skills/a2ui-doc-sync-check in your project. Claude Code loads it when a task matches its description.

How do I install A2ui Doc Sync Check in Codex?

Run `npx skills add a2ui-project/a2ui --skill a2ui-doc-sync-check -a codex`. Or copy the skill folder (.agents/skills/a2ui-doc-sync-check in a2ui-project/a2ui) into .agents/skills/a2ui-doc-sync-check in your project. Codex loads it when a task matches its description.

Can I use A2ui Doc Sync Check in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add a2ui-project/a2ui --skill a2ui-doc-sync-check -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/a2ui-doc-sync-check, .gemini/skills/a2ui-doc-sync-check, .github/skills/a2ui-doc-sync-check and .opencode/skills/a2ui-doc-sync-check in your project.

What does A2ui Doc Sync Check need to run?

SKILL.md names no scripts, command-line tools or credentials: A2ui Doc Sync Check is instructions for the agent only.

Does A2ui Doc Sync Check access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is A2ui Doc Sync Check safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does A2ui Doc Sync Check use?

A2ui Doc Sync Check is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does A2ui Doc Sync Check use?

About 824 tokens (SKILL.md is roughly 3.3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to A2ui Doc Sync Check?

Skills that share tags, products or a category with A2ui Doc Sync Check: Diagram Design (cathrynlavery/diagram-design, 45k stars), Simple English (moeru-ai/airi, 50k stars), Get API Docs with chub (andrewyng/context-hub, 14k stars) and Doc Sync (JetBrains/ideavim, 10k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains A2ui Doc Sync Check?

a2ui-project (a GitHub organization) maintains it in a2ui-project/a2ui, which has 16,617 GitHub stars. The repository holds 20 skills in this directory. The repository was last updated on October 8, 2026.

Source: a2ui-project/a2ui on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.