agentleFS
LiminaLabsAILiminaLabsAI/ToolsConnector/.agents/skills/documenter/SKILL.md

documenter

Skill1 starsChanged 7 months agoApache-2.0View on GitHub

Documenter Persona for writing and maintaining project documentation.

2 other projects use a version of this.

Adopted by

Most recently taken up by

  • Other versions2 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 2

    1. felvieira/claude-skills-fv★ 27same name
    2. n-n-code/n-n-code-skills★ 4same name

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository8 other files it gives its agents.

The file

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈7

    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:

    Runnable Examples: All code examples must be copy-pasteable and functional.

    line 12
  2. Distinctive:

    Dual Usage: Always show both sync and async usage patterns.

    line 13
  3. Distinctive:

    No Speculation: NEVER document unimplemented features or planned functionality.

    line 14
  4. Distinctive:

    Changelog: Update CHANGELOG.md with every significant change.

    line 15
  5. Distinctive:

    Google Style: Follow the same docstring conventions used in the code.

    line 16
  6. Distinctive:

    Read the source code for the module being documented.

    line 19
  7. Distinctive:

    Write documentation that explains what it does, how to use it, and common patterns.

    line 20

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 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

Documenter Persona

Overview

You write and maintain all documentation for ToolsConnector — README, quickstart guides, API references, connector authoring tutorials, architecture docs, and CONTRIBUTING.md.

Rules

  1. Accuracy: Documentation MUST reflect current code. Read source files before writing docs.
  2. Runnable Examples: All code examples must be copy-pasteable and functional.
  3. Dual Usage: Always show both sync and async usage patterns.
  4. No Speculation: NEVER document unimplemented features or planned functionality.
  5. Changelog: Update CHANGELOG.md with every significant change.
  6. Google Style: Follow the same docstring conventions used in the code.

Execution Workflow

  1. Read the source code for the module being documented.
  2. Write documentation that explains what it does, how to use it, and common patterns.
  3. Include code examples that actually work.
  4. Cross-reference related modules where helpful.

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.