agentleFS
Sign inStart free
onegunsamuraionegunsamurai/OpenLearning/.claude/skills/doc-sync/SKILL.md

doc-sync

Skill1 starsChanged 8 months agoMITView on GitHub

Verify documentation accuracy against the current codebase

34 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use api-endpoint, perf-budget and 6 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • tadoEngSkill

    api-endpoint

    Add or change a backend API endpoint on this product, keeping Pydantic as the single contract authority and regenerating the TypeScript client. Use when asked to add an endpoint, expose data to the frontend, change a request or response shape, or wire a new backend capability into a page.

    Also in 4 projects that use this

  • vindreshsinghSkill

    perf-budget

    Optimizes performance by measuring first and fixing the real bottleneck. Use when something is slow, before optimizing, when setting latency or bundle targets, or reviewing changes for performance traps — not for speculative micro-tuning.

    Also in 3 projects that use this

  • AnasX7Skill

    improve

    Survey any codebase as a senior advisor and produce prioritized, self-contained implementation plans for OTHER models/agents to execute. Strictly read-only on source code — never implements, fixes, or refactors anything itself. Use when asked to audit a codebase, find improvement opportunities (bugs, security, performance, test coverage, tech debt, migrations, DX), suggest features or where to take the project next (roadmap, product direction), or generate handoff plans for another agent to implement.

    Also in 3 projects that use this

  • dillonluiSkill

    design-review

    Review a view or flow for UX and UI issues. Provides severity-ranked, actionable findings grounded in established design heuristics. Use when the user asks for design feedback, UX review, or UI critique.

    Also in 3 projects that use this

  • Microsoft AzureSkill

    design

    Design rules and conventions for the API Center Portal. Use when editing detail pages, card components, badges, layout, navigation, sidebars, or headers. Covers badge styling, metadata placement, page navigation patterns, and layout alignment.

    Also in 3 projects that use this

  • NVIDIASkill

    research

    Before designing a feature, research how comparable libraries solve the problem, check best practices, known pitfalls, and upstream changes. Use when starting a new feature, investigating an unfamiliar area, or the user asks to research something.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

2 rules. 0 are common, 0 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 27 edited versions we read keep these.

  • 0

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Check commands: Verify all make targets and scripts/ referenced in docs exist and have correct syntax.

    line 29
  2. Very specific:

    Validate build: Run mkdocs build --strict to catch broken links and missing pages.

    line 33

“Common” is measured: kept by at least 6 in 10 of the 27 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Documentation Sync Verification

Audit project documentation to ensure it accurately reflects the current codebase. Update Code -> Docs Mapping in this document and in .claude/agents/doc-writer.md if any discrepancies are found or new code areas are added.

Mapping: Code → Docs

Code AreaDocumentation File
backend/app/routes/docs/guides/api-reference.md
backend/app/agents/docs/architecture/assessment-pipeline.md
backend/app/models/docs/architecture/data-models.md
frontend/src/docs/guides/knowledge-base.md
Makefile, scripts/docs/development/
System overviewdocs/architecture/overview.md

Steps

  1. Inventory routes: List all @router endpoints in backend/app/routes/ and compare against docs/guides/api-reference.md. Flag any missing or outdated entries.
  2. Inventory agents: List all agent classes in backend/app/agents/ and compare against docs/architecture/assessment-pipeline.md. Verify the pipeline description matches the current agent graph.
  3. Check data models: List all Pydantic models in backend/app/models/ and compare field names/types against docs/architecture/data-models.md.
  4. Check commands: Verify all make targets and scripts/ referenced in docs exist and have correct syntax.
  5. Check code examples: For any code snippets in docs, verify they compile/run against the current codebase.
  6. Validate build: Run mkdocs build --strict to catch broken links and missing pages.

Output Format

For each discrepancy found:

  • File: doc file path and line number
  • Issue: what's wrong (missing, outdated, incorrect)
  • Fix: suggested correction with code reference

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free