agentleFS
Sign inStart free
srikanth-manivannansrikanth-manivannan/claude-agent-factory/skills/documentation/doc-writer/SKILL.md

doc-writer

Skill1 starsChanged 5 months agoMITView on GitHub

Use this to write or refresh a README and docs from code and intent, following the documentation standard.

20 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use code-review.

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.
  • 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 3 projects that use this

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 17 edited versions we read keep these.

  • 1

    Distinctive

    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:

    Be accurate, not aspirational: Document actual behavior; mark known limitations honestly.

    line 51

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

Doc Writer

Use this to write or refresh a README and docs from code and intent, following the documentation standard.

Tech profile — Technology: any · Language: any · Stack: any · Toolchain: any · Domain: documentation (Documents any artifact or codebase; structure comes from the documentation standard.)

When to use this skill

  • Writing a README for new code, a skill, or a project.
  • Refreshing stale docs to match current behavior.
  • Standardizing docs across a repo to a consistent shape.

When NOT to use this skill

  • Generating API reference from a spec — use documentation/api-reference-generator.
  • Linting existing docs only — use documentation/doc-linter.
  • Writing inline docstrings — use documentation/docstring-writer.

Prerequisites

  • The subject (code, artifact, or feature) and its intent/audience.

Inputs

InputRequiredDescription
subjectyesWhat is being documented
audiencenoWho reads it (defaults to developers)
existing_docsnoCurrent docs to refresh, if any

Instructions

  1. Identify subject, audience, and purpose. What problem does it solve; who reads this and why.
  2. Apply the required structure from /standards/documentation.md: title + one-sentence description, What it does, Quickstart, Inputs & outputs, Customization, Limitations, Changelog link.
  3. Write a runnable Quickstart. Copy-pasteable; the fastest path to first value.
  4. Be accurate, not aspirational. Document actual behavior; mark known limitations honestly. Never describe features that don't exist.
  5. Cross-reference, don't duplicate. Link to standards/related artifacts instead of restating them.
  6. Keep it GitHub-readable. Headings, tables, short paragraphs, working relative links.
  7. Verify no leftover placeholders and that links resolve.

Output

A complete README.md (and any requested companion docs) matching the documentation standard's required sections, accurate to current behavior, with working links.

Constraints & safety

  • One-sentence description (/standards/naming.md).
  • No invented behavior; no stale claims.
  • No secrets in examples (/standards/security.md).

Examples

Minimal below; full examples in EXAMPLES.md.

Given: an undocumented utility library. Produces: a README with a one-line description, a 3-step quickstart, inputs/outputs, customization, and honest limitations.

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