agentleFS
typvtypv/nest-turbo-starter/.claude/skills/docs/SKILL.md

docs

Skill224 starsChanged 3 months agoMITView on GitHub

Analyze codebase and manage project documentation — init, update, summarize.

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 129 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:

    If invoked without arguments, use AskUserQuestion to present available documentation operations:

    line 13
  2. Very specific:

    Use docs/ directory as the source of truth for documentation.

    line 53

“Common” is measured: kept by at least 6 in 10 of the 129 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 Management

Analyze codebase and manage project documentation through scouting, analysis, and structured doc generation.

Default (No Arguments)

If invoked without arguments, use AskUserQuestion to present available documentation operations:

OperationDescription
initAnalyze codebase & create initial docs
updateAnalyze changes & update docs
summarizeQuick codebase summary

Present as options via AskUserQuestion with header "Documentation Operation", question "What would you like to do?".

Subcommands

SubcommandReferencePurpose
/docs initreferences/init-workflow.mdAnalyze codebase and create initial documentation
/docs updatereferences/update-workflow.mdAnalyze codebase and update existing documentation
/docs summarizereferences/summarize-workflow.mdQuick analysis and update of codebase summary

Routing

Parse $ARGUMENTS first word:

  • init → Load references/init-workflow.md
  • update → Load references/update-workflow.md
  • summarize → Load references/summarize-workflow.md
  • empty/unclear → AskUserQuestion (do not auto-run init)

Shared Context

Documentation lives in ./docs directory:

./docs
├── project-overview-pdr.md
├── code-standards.md
├── codebase-summary.md
├── design-system/            # Design principles, tokens, catalog, themes
├── deployment-guide.md
├── system-architecture.md
└── project-roadmap.md

Use docs/ directory as the source of truth for documentation.

IMPORTANT: Do not start implementing code.

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.