agentleFS
motao123motao123/dev-workflow-kit/docs-writer/SKILL.md

docs-writer

Skill1 starsChanged 5 months agoMITView on GitHub

Use when completed or in-progress work needs documentation such as README updates, migration notes, release notes, usage examples, or developer-facing operational guidance. This skill writes docs grounded in the current code and verified behavior.

28 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use docs-planner, docs-reviewer and 3 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.
  • strands-agentsSkill

    docs-planner

    Find the gaps in the Box documentation and produce a prioritized backlog for docs/user/ and docs/design/. Use when planning documentation work, after a feature or a binary ships without a page, for a periodic health check of the docs, or when asked "what docs need writing", "plan the docs work", "prioritize the docs backlog", or "what should we document next".

    Also in 3 projects that use this

  • strands-agentsSkill

    docs-reviewer

    Review Box drafts in docs/user/ or docs/design/, and wording-only rewrites in docs/dev/. Use after docs-writer, before a docs pull request, or for a requested doc review. Check style and preservation of meaning, then give a Ship it, Tighten, or Rethink verdict. Read-only.

    Also in 3 projects that use this

  • hiroppySkill

    docs-audit

    Audit docs/ design documents, specs, and implementation plans against current source code for drift. Outputs a drift report and updates documents. Triggers on "check if docs are up to date", "diff docs vs code", "update design docs", "docs consistency check", "verify specs match source", "check plan completion status". Most effective after code or documentation changes.

    Also in 3 projects that use this

  • GoogleSkill

    code-review

    Adversarial systems, concurrency, memory-model, and architecture code review protocol. Use this skill whenever asked to review code, PRs, diffs, or branches in Filament.

    Also in 4 projects that use this

  • GoogleSkill

    tdd

    Test-driven development. Use when the user wants to build features or fix bugs test-first, mentions "red-green-refactor", or wants integration tests.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 26 edited versions we read keep these.

  • 6

    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:

    Use this skill when project knowledge needs to be turned into durable documentation.

    line 9
  2. Distinctive:

    Use this skill when:

    line 13
  3. Distinctive:

    Do not use this skill to invent architecture or behavior that is not supported by the current code.

    line 20
  4. Distinctive:

    Read the relevant code and existing docs first.

    line 24
  5. Distinctive:

    Write the smallest docs that close the knowledge gap.

    line 27
  6. Distinctive:

    use the active implementation workflow if the behavior is still changing

    line 42
  7. Very specific:

    use ship-readiness if docs are part of release completion

    line 43
  8. Very specific:

    use security-review if the docs touch sensitive operational guidance

    line 44

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

Docs Writer

Use this skill when project knowledge needs to be turned into durable documentation.

Trigger Conditions

Use this skill when:

  • README or setup docs need updates
  • a change requires migration notes or release notes
  • usage examples must be added
  • implementation behavior should be documented for other developers
  • the user asks for docs tied to real code changes

Do not use this skill to invent architecture or behavior that is not supported by the current code.

Workflow

  1. Read the relevant code and existing docs first.
  2. Identify the audience and purpose.
  3. Capture only the behavior that is real and current.
  4. Write the smallest docs that close the knowledge gap.
  5. Preserve examples and step ordering where they help.
  6. Note any missing verification if docs depend on untested behavior.

Output

For non-trivial work, provide:

  • target audience
  • docs updated or drafted
  • source of truth consulted
  • open gaps or assumptions

Coordination

Before documentation:

  • use the active implementation workflow if the behavior is still changing
  • use ship-readiness if docs are part of release completion
  • use security-review if the docs touch sensitive operational guidance

Invocation Examples

  • "Use docs-writer to update the README for this new setup flow."
  • "Use docs-writer to draft migration notes for this breaking change."
  • "Use docs-writer to create a short release note and usage example."

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.