agentleFS
roborracleroborracle/agent-workflow-kit/skills/tech-docs/SKILL.md

tech-docs

Skill0 starsChanged 3 months agoMITView on GitHub

Generate and maintain technical documentation. Covers READMEs, architecture decision records (ADRs), API docs, runbooks, and onboarding guides.

2 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    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:

    Every public function/endpoint has a brief description

    line 20
  2. Distinctive:

    No documentation references removed code or outdated APIs

    line 24

≈ “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

Technical Documentation Writer

Document Templates

Templates in templates/ directory:

  • README template — Standard project README structure
  • ADR template — Architecture Decision Record
  • Runbook template — Operational procedure playbook
  • Onboarding template — Developer onboarding checklist

Documentation Quality Checks

  • Every public function/endpoint has a brief description
  • README can get a new developer from zero to running in < 15 minutes
  • ADRs exist for every non-obvious architectural choice
  • Runbooks exist for every operational procedure
  • No documentation references removed code or outdated APIs

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.