agentleFS
prestariusprestarius/jet-skills-stack/skills/document/SKILL.md

document

Skill1 starsChanged 2 months agoMITView on GitHub

Generate complete, structured documentation for a feature, module, API, or project using the Diataxis framework (tutorial / how-to / reference / explanation). Use whenever the user asks to "write docs", "document this", "generate documentation", "write a tutorial", "write a how-to", or "explain this module". Reads the real code before writing and never documents behavior the code doesn't have.

54 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use develop, scope and 10 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.
  • hong9LeeSkill

    develop

    빌드, 아키텍처, git 관련 작업 시 OMS MSA 공통 인프라 규칙을 적용한다. 기술 스택, 빌드 명령, 헥사고날 아키텍처 구조, git 워크플로우, AI Context 동기화 규칙을 다룬다. 코드 작성 컨벤션은 /convention, 테스트 컨벤션은 /test-guide 스킬을 참조.

    Also in 5 projects that use this

  • YuriNachosSkill

    scope

    Configure claude-scope status line widgets for Claude Code. Use when user wants to customize widgets, change theme, reorder elements, or modify display style.

    Also in 5 projects that use this

  • ralphkraussSkill

    resolve-conflicts

    Resolve git merge conflicts or re-apply changes from a stale branch onto current main. Use when user says "resolve conflicts", "merge conflicts", "rebase branch", "branch is behind", "re-apply changes", "port branch", or a branch is too far behind main to merge cleanly.

    Also in 3 projects that use this

  • MicrosoftSkill

    sync

    Sync the current session branch with its upstream branch, or publish the current session branch to a remote. Use when the user asks to sync a branch, pull latest changes, rebase onto upstream, push current branch, publish branch, or set upstream.

    Also in 5 projects that use this

  • kt057Skill

    check

    lint, typecheck, test を一括実行して結果をサマリーする

    Also in 7 projects that use this

  • Microsoft AzureSkill

    test

    Also in 12 projects that use this

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 50 edited versions we read keep these.

  • 2

    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:

    Read ./CONTEXT.md if present for the stack, domain language, and where docs already live.

    line 11
  2. Distinctive:

    Read the code first (non-negotiable): Before writing a line, read the implementation, its tests, config, and the public surface.

    line 12
  3. Very specific:

    Self-review against the code: Check every factual claim against the implementation, confirm examples run (macOS-first commands), and keep …

    line 28
  4. Distinctive:

    Don't pad, don't duplicate the same content across quadrants, and don't auto-commit — present the files for review.

    line 32

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

Produce documentation a reader can actually use, partitioned by what they need — not one undifferentiated wall of prose.

  1. Scope & intent. Confirm what to document and for whom. Ask once whether output should be inline (docstrings/README sections) or standalone files under docs/ — default to standalone. Read ./CONTEXT.md if present for the stack, domain language, and where docs already live.
  2. Read the code first (non-negotiable). Before writing a line, read the implementation, its tests, config, and the public surface. Documentation is derived from what the code does, not what it should do. If something is undocumented because it's unclear, say so — don't invent it.
  3. Partition by Diataxis. Decide which of the four quadrants the subject actually needs (not everything needs all four):
    • Reference — complete, accurate, factual description of the surface (API, flags, config). Information-oriented. Tie every entry to the code.
    • Explanation — why it works this way: design decisions, trade-offs, alternatives rejected. Understanding-oriented. (If a decision is load-bearing, suggest capturing it via the domain-modeling skill.)
    • How-to — task-oriented recipes that assume basic familiarity ("how to add a new handler").
    • Tutorial — a learning-oriented walkthrough for a newcomer, with a working example that produces a visible result early. Every step must actually run.
  4. Write reference first, then explanation, then how-to, then tutorial. Reference grounds the rest; the others link back to it.
  5. Cross-link and index. Connect the quadrants to each other and update the README / docs index so the new pages are discoverable. Don't leave orphans.
  6. Self-review against the code. Check every factual claim against the implementation, confirm examples run (macOS-first commands), and keep the voice plain — apply the humanizer patterns to your own output. Markdown by default.

Don't pad, don't duplicate the same content across quadrants, and don't auto-commit — present the files for review.

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.

Reviews can't be read right now.

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.