agentleFS
TsukiNi22TsukiNi22/ai-utils/skills/routers/doc/SKILL.md

doc

Skill1 starsChanged 3 days agoMITView on GitHub

Router for documentation tasks of the user - README and Markdown docs, GitHub wiki, CHANGELOG / release notes, HTML documentation (user guide, technical doc, project graph), explanation pages (simple + technical), protocol / wire format docs, HTML style, reports, code comments - loads readme-style, wiki-style, html-doc, better-html-doc, explain-doc, better-explain-doc, protocol-doc, better-protocol-doc, html-style, better-html-style, report, docs-update, git-conventions or cpp-comments depending on what is documented. Invoke manually with /doc.

35 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use test, explain and 8 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.
  • Microsoft AzureSkill

    test

    Also in 5 projects that use this

  • sunnyclinches44Skill

    explain

    Explains code using real-world analogies and ASCII diagrams

    Also in 4 projects that use this

  • dazuckSkill

    interview

    Interview me about a plan to flesh out requirements before implementation. Asks non-obvious questions one at a time until all ambiguities are resolved.

    Also in 3 projects that use this

  • SentrySkill

    review

    Fixture review skill.

    Also in 8 projects that use this

  • BlockSkill

    plan

    Draft a TDD, PRD, or lightweight plan in the conversation without committing it.

    Also in 4 projects that use this

  • GitHubSkill

    refactor

    Surgical code refactoring to improve maintainability without changing behavior. Covers extracting functions, renaming variables, breaking down god functions, improving type safety, eliminating code smells, and applying design patterns. Less drastic than repo-rebuilder; use for gradual improvements.

    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, 1 is distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 27 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

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

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

    Check every name/command/API against the code before writing it.

    line 40
  2. Distinctive:

    Start the answer with one line listing the loaded skills.

    line 41

“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 router

Request given with /doc: $ARGUMENTS

Load the skills with the Skill tool (never the other routers: they are manual-only), then write. The request is the text given with /doc (or the latest request; if none, inspect README.md, CHANGELOG.md, docs/ and propose what is missing or outdated).

Context

  • Existing docs: README.md, CHANGELOG.md, docs/*.html, wiki (<repo>.wiki), Doxyfile.
  • What changed since the docs were written: git log --oneline -- . ':!docs' | head, version in CMakeLists.txt.
  • Audience: users (non-technical) or developers.

Skills

SituationSkills
README, Markdown guidereadme-style
GitHub wiki (<repo>.wiki: Home, sidebar, section pages)wiki-style (+ readme-style for the Markdown rules, libutils for a libutils based project)
HTML documentation, docs/ site, GitHub Pages, project graphhtml-doc (+ readme-style for the README link)
a documentation site with search, several pages / sections, EN / FR, "like the claude-cluster docs", "better" docsbetter-html-doc (+ better-html-style; explanations in it: better-explain-doc, protocol pages: better-protocol-doc)
explain how something works (concept, algorithm, protocol, math) with diagrams / animations / interactive examples, simple + technicalexplain-doc (+ html-style)
specify / document a protocol, a wire or message format, a handshake, the commands of a client / server, a storage format (the reference of the frames, codes and commands)protocol-doc (it asks the output: Markdown, PDF via report, HTML sections via html-doc)
any other HTML page, a palette / color / font / theme to definehtml-style (better-html-style for the claude-cluster docs look with search)
CHANGELOG, release notes, PR descriptiongit-conventions
comments / documentation inside the code (any language), file headerscomments (+ cpp-comments for C++, python-comments for Python)
a result / report / study delivered as PDFreport
doc of a libutils based projectalso libutils (exact APIs)
update all the docs after changes / a new version (README, CHANGELOG, HTML site, gh-pages, wiki, packages / manifests, install scripts, help texts)docs-update (it loads the others by surface: readme-style, wiki-style, html-doc, git-conventions)
full documentation passdocs-update

Always

  • An audit / summary of the docs is delivered through report (format asked once, English, audit/ at the repository root).
  • Check every name/command/API against the code before writing it; mark planned vs implemented.
  • Start the answer with one line listing the loaded skills.

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.