agentleFS
Sign inStart free
ishandutta2007ishandutta2007/Awesome-Claude-Skills/skills/documentation/skill.md

documentation

Skill16 starsChanged 6 months agoMITView on GitHub

Output: "Created src/billing/CONTEXT.md with core terms: Invoice, LineItem, Adjustment. Added ADR-0004 for using Stripe as the primary source of truth."

112 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use create-media-pack, project-preferences 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.
  • DepressionCenterSkill

    create-media-pack

    Create a coordinated project branding and media pack with three accessible design options, approved vector artwork, image exports, a branding guide, and README integration. Use when asked for a repository media pack, brand kit, or complete project visual identity.

    Also in 5 projects that use this

  • DepressionCenterSkill

    project-preferences

    Apply repository-specific preferences when planning, implementing, or reviewing changes in this project.

    Also in 6 projects that use this

  • thistleknotSkill

    response-style

    Response and prose protocol. Use when drafting user-facing prose, expanding a user's ideas, or tuning tone and format to preserve voice, avoid AI cliches, and maintain coherent answers.

    Also in 7 projects that use this

  • BrowserWorksSkill

    accessibility-frontend-review

    Performs an accessibility code review of a local diff or Phabricator revision in the style of the Firefox accessibility team. Use this skill whenever the user asks to review a Phabricator patch or revision for accessibility issues, mentions a D-number (like D284142) in the context of accessibility review, asks "does this patch have any a11y issues", or wants to check a diff against accessibility guidelines. Also use it when the user says things like "can you review this for a11y", "check this patch", or "give me an accessibility review of D[number]". Invoke proactively when the user pastes a phabricator.services.mozilla.com URL or shares a revision ID alongside any accessibility concern. Invoke when questions about the following topics are raised: aria properties, aria roles, high contrast mode, forced colors, prefers contrast, focus order, screen readers, assistive technology.

    Also in 4 projects that use this

  • BrowserWorksSkill

    android-new-module

    Guide for creating new Android gradle modules in the android-components project.

    Also in 4 projects that use this

  • +7 more from BrowserWorks

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 101 edited versions we read keep these.

  • 5

    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. Distinctive:

    Create clear, concise, and durable documentation that helps both humans and agents navigate the codebase and understand the domain.

    line 7
  2. Very specific:

    Shared Language: Use and update the project's domain glossary (CONTEXT.md).

    line 10
  3. Distinctive:

    ADR Discipline: Use Architecture Decision Records (ADRs) for hard-to-reverse choices.

    line 11
  4. Distinctive:

    Concision: Prefer 10 words over 100. Focus on "Why" more than "What".

    line 12
  5. Distinctive:

    Laziness: Only document what is necessary for understanding or maintainability.

    line 14
  6. Very specific:

    Drafting: Create or update documentation (READMEs, CONTEXT.md, ADRs).

    line 18
  7. Distinctive:

    Linking: Ensure documentation is discoverable and properly linked.

    line 20

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

Skill: Technical Documentation

Role

You are a Technical Writer and Documentation Architect specializing in "Shared Language" and architectural records.

Objective

Create clear, concise, and durable documentation that helps both humans and agents navigate the codebase and understand the domain.

Constraints

  • Shared Language: Use and update the project's domain glossary (CONTEXT.md).
  • ADR Discipline: Use Architecture Decision Records (ADRs) for hard-to-reverse choices.
  • Concision: Prefer 10 words over 100. Focus on "Why" more than "What".
  • AI-Navigability: Structure docs to be easily parsed by coding agents.
  • Laziness: Only document what is necessary for understanding or maintainability.

Process

  1. Audit: Review existing docs to identify gaps or outdated information.
  2. Drafting: Create or update documentation (READMEs, CONTEXT.md, ADRs).
  3. Refinement: Simplify language and ensure consistent terminology.
  4. Linking: Ensure documentation is discoverable and properly linked.

Output Format

  • Updated Docs: The specific files or sections modified.
  • Glossary Updates: New terms added to the domain model.
  • ADR Summary: Brief explanation of new architectural decisions.

Examples

Example 1: Documenting a New Domain

Input: "Document how the 'Billing' module works."

Output: "Created src/billing/CONTEXT.md with core terms: Invoice, LineItem, Adjustment. Added ADR-0004 for using Stripe as the primary source of truth."

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