agentleFS
jdinklajdinkla/user-story-skills/skills/story-auto-documentation/SKILL.md

story-auto-documentation

Skill0 starsChanged 7 months agoMITView on GitHub

Pre-draft documentation updates for a user story — Overview, User Guide, API Reference, Configuration, Changelog — ready for Confluence, Notion, README, or API docs. Use when the user asks "draft the docs for this", wants release notes, or needs markdown-ready documentation before a feature ships.

The file

We split this skill into the rules it gives an agent

1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    If none of the above, ask the user to paste the story or point to a file.

    line 17

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “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

Auto-Documentation Generator

Pre-draft the documentation updates a user story will require, in markdown ready for Confluence, Notion, README, or API docs.

Input

Take the user story from whichever of these is available first:

  1. Text passed as arguments to this skill or slash command.
  2. A file reference like @path/to/story.md — read the file first.
  3. The current editor selection or most recently referenced story in the conversation.
  4. If none of the above, ask the user to paste the story or point to a file.

Instructions

You are a technical writer specializing in software documentation.

Your task is to pre-draft documentation updates required for a user story, suitable for Confluence, Notion, README files, or API documentation.

Guidelines:

  1. Identify target audiences: end users, developers / API consumers, DevOps / administrators, internal team members.
  2. Generate documentation sections (pick the ones that apply; 2–5 total):
    • Overview — what the feature does and why it matters (user-facing)
    • User Guide — step-by-step instructions for end users
    • API Reference — endpoint documentation if applicable
    • Configuration — env vars, settings, options
    • Changelog Entry — release-notes style description
  3. For each section, provide:
    • Section Type — overview / user_guide / api_reference / configuration / changelog
    • Title — clear, descriptive heading
    • Content — the actual documentation text (markdown-ready)
    • Code Snippets — example code, API calls, or commands (in fenced code blocks)
    • Notes — important warnings, tips, or caveats
  4. API Endpoints (if applicable): HTTP method + path, description, required/optional parameters, example response.
  5. Configuration Notes: env vars needed, feature flags, default values and overrides.
  6. Migration Notes: breaking changes, data migration steps, backwards-compatibility notes.
  7. Changelog Entry: concise release-notes summary; category (Added/Changed/Fixed/Removed); user-facing description.

Comprehensive but not excessive — focus on what's actually needed for this specific feature.

Output format

Render as markdown in the chat. Structure it so each section is directly copy-pastable into the destination doc.

  • Title: "Documentation Draft for [Feature]"
  • Target Audiences — 1–2 sentences
  • Sections — 2–5 documentation sections, each with its own heading, Markdown body, code snippets, and notes
  • API Endpoints (if applicable) — method, path, params, example response
  • Configuration — env vars, feature flags
  • Migration Notes — if applicable
  • Changelog Entry — short bullet suitable for release notes

No JSON.

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.