agentleFS
Sign inStart free
ES-92ES-92/esc/skills/docs/SKILL.md

docs

Skill0 starsChanged 4 months agoMITView on GitHub

Pflegt die mitlaufende, lebende Projekt-Dokumentation esc/docs/DOCUMENTATION.md von ESC mit Mermaid-Diagrammen — Systemkontext, Architektur/Komponenten, Datenmodell (erDiagram), Kern-Flows (sequenceDiagram) und Glossar. Kann optional einen leichten lokalen Doku-Viewer (docsify) einrichten und auf einem erfragten Port starten. Use when the user says "doku aktualisieren", "dokumentation", "diagramme", "doku-viewer", "esc docs", or wird am Ende relevanter Phasen automatisch aufgerufen.

165 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use import-memory, perf and 8 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.
  • amirbironSkill

    import-memory

    Import a memory export from another AI assistant into Claude's memory — conversationally, additively, and with the content treated as data.

    Also in 3 projects that use this

  • MicrosoftSkill

    perf

    Speed and memory performance rules for Rust crates, the Node addon, webui-framework, and webui-delivery.

    Also in 4 projects that use this

  • diego-tobalinaSkill

    build-fix

    Fix build and compilation errors systematically. Run when build fails.

    Also in 3 projects that use this

  • JkudjoSkill

    incident

    Production incident response — structured triage, hypothesis tree, safe remediation, incident record

    Also in 4 projects that use this

  • vbrevikSkill

    work

    Use when the user says 'plan', 'todo', 'copy plan', 'append plan', 'resume plan', 'priorities', or 'what's next'.

    Also in 7 projects that use this

  • mbwsimsSkill

    impact

    This skill should be used when the user asks to "check the impact", "what will break if I change this", "blast radius", "impact analysis", "what depends on this", "who imports this", "is it safe to change this", mentions "/impact", or wants to understand the consequences of modifying a specific file or function before making changes.

    Also in 3 projects that use this

The file

Create a free account to mount
Files
SKILL.md

esc:docs — Lebende Dokumentation pflegen

Ziel: esc/docs/DOCUMENTATION.md als immer aktuelle, diagrammgestützte Sicht auf das Produkt führen. Die Doku wird aus den vorhandenen Artefakten abgeleitet, nicht neu erfunden.

Lies zuerst

  • ${CLAUDE_PLUGIN_ROOT}/shared/tracking.md — Format & Mermaid-Vorlagen für DOCUMENTATION.md
  • Vorhandene Artefakte: esc/specs/product-brief.md, esc/specs/prd.md, esc/specs/ux-spec.md, esc/specs/architecture/architecture.md, esc/specs/architecture/decisions/, esc/state.yaml

Ablauf

1. Bestand sichten

Lies DOCUMENTATION.md (falls vorhanden) und die Artefakte. Bestimme, welche Abschnitte sich seit dem letzten Stand geändert haben oder neu befüllbar sind.

2. Abschnitte aus Artefakten ableiten/aktualisieren

Pflege je nach vorhandenem Wissen (siehe Zuordnungstabelle in shared/tracking.md):

  • Überblick & Vision — aus Brief/PRD (Problem, Zielgruppe, Kernnutzen).
  • Systemkontext (flowchart TB) — Akteure ↔ System ↔ externe Dienste.
  • Architektur & Komponenten (flowchart) — aus architecture.md, mit Verweis auf ADRs.
  • Datenmodell (erDiagram) — Kern-Entitäten & Beziehungen aus der Architektur.
  • Kern-Flows (sequenceDiagram) — die 3–5 wichtigsten Abläufe aus PRD/UX.
  • Glossar — Fachbegriffe konsistent halten.
  • Verweise — auf PRD, ADRs, Stories. Nur Abschnitte schreiben, für die belastbares Wissen existiert; den Rest als „folgt" markieren.

3. Mermaid-Korrektheit

Bezeichner ohne Umlaute/Sonderzeichen, Labels in ["…"] dürfen Umlaute enthalten. Diagramme klein und fokussiert halten. Bei Aktualisierung das ganze betroffene Diagramm neu schreiben.

4. Konsistenz-Check

Doku darf den Specs nicht widersprechen. Findest du Widersprüche (z. B. Datenmodell ≠ PRD), den Nutzer darauf hinweisen statt still zu glätten.

5. Doku-Viewer (optional, docsify)

Prüfe, ob esc/viewer/index.html existiert.

  • Existiert nicht: Biete dem Nutzer per Auswahl an, einen leichten lokalen Viewer (docsify) einzurichten. Bei Ja: nach ${CLAUDE_PLUGIN_ROOT}/shared/viewer.md vorgehen (index.html aus Template, _sidebar.md generieren, .nojekyll anlegen) und den Server starten — Port immer explizit erfragen und auf frei prüfen.
  • Existiert: esc/_sidebar.md an neue Dateien anpassen und anbieten, den Viewer zu starten (wieder mit Port-Frage). URL http://localhost:<PORT>/viewer/ und Stopp-Hinweis nennen. Niemals ungefragt aufsetzen oder einen Server starten.

Definition of Done

  • Alle aus den aktuellen Artefakten ableitbaren Abschnitte sind aktuell.
  • Mindestens Systemkontext + (sofern Architektur existiert) Datenmodell als gültige Mermaid-Diagramme.
  • Keine Widersprüche zu den Specs; offene Stellen als „folgt" markiert.
  • Viewer-Angebot gemacht (bzw. bei vorhandenem Viewer _sidebar.md aktuell); Server nur auf Wunsch + mit Port-Frage gestartet.

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