Index of every page on this site: llms.txt
All skills
a2ui-project avatar

/a2ui-doc-sync-check

@6bf4cc2
by A2UIa2ui-project/a2ui18k stars
1,430
Run it yourself

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

Use this Skill: https://skilld.dev/gh/a2ui-project/a2ui/a2ui-doc-sync-check

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈34 tokens for metadata: the name and description. ≈787 when used: this file.

Description uses 1.7% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈138 characters, or 1.7%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

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.

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No alerts3mo3 checks · Risk SAFE
  • Gen Agent Trust Hub3mo

    The skill is a safe auditing tool that identifies discrepancies between documentation and code. It performs analysis by reading local files such as READMEs, docstrings, and project configurations. It does not perform network operations, execute scripts, or require sensitive credentials.

  • Socket3mo

    No alerts

  • Snyk3mo

    Risk: LOW · No issues

Signed by skilld at 6bf4cc2. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated last week
metadata
{
  "internal": true
}

README badge

README badge for a2ui-project/a2ui/a2ui-doc-sync-check