agentleFS
Sign inStart free
KylinMountainKylinMountain/nano-claw/skills/builtin/docs-writer/SKILL.md

docs-writer

Skill4 starsChanged 9 months agoMITView on GitHub

Specialized skill for writing technical documentation

29 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 4 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

  • SentrySkill

    security-review

    Finds exploitable application security vulnerabilities in code changes. Use for Warden security scans, appsec review, OWASP-style checks, authentication or authorization bugs, injection, XSS, SSRF, path traversal, secrets, unsafe crypto, webhook verification, open redirects, or sensitive data exposure.

    Also in 4 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

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

  • 0

    Common

    Most of the 27 edited versions we read keep these.

  • 7

    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:

    When activated, follow these documentation best practices:

    line 15
  2. Distinctive:

    Structure: Use clear hierarchical headings (H1, H2, H3)

    line 17
  3. Distinctive:

    Clarity: Write in simple, direct language

    line 18
  4. Distinctive:

    Maintenance: Keep documentation up-to-date with code changes

    line 21
  5. Distinctive:

    Add diagrams where helpful

    line 43
  6. Distinctive:

    Test all code examples

    line 44
  7. Distinctive:

    Consider your audience's technical level

    line 45

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

Documentation Writer Skill

Purpose

This skill provides specialized guidance for writing high-quality technical documentation, including README files, API documentation, user guides, and code comments.

Guidelines

When activated, follow these documentation best practices:

  1. Structure: Use clear hierarchical headings (H1, H2, H3)
  2. Clarity: Write in simple, direct language
  3. Examples: Include practical code examples
  4. Completeness: Cover installation, usage, and troubleshooting
  5. Maintenance: Keep documentation up-to-date with code changes

Templates

README Template

  • Project overview
  • Installation instructions
  • Quick start guide
  • API reference
  • Contributing guidelines
  • License information

API Documentation

  • Endpoint descriptions
  • Request/response examples
  • Error codes
  • Authentication details

Best Practices

  • Use consistent formatting
  • Include table of contents for long documents
  • Add diagrams where helpful
  • Test all code examples
  • Consider your audience's technical level

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