CommunitySchreiben & Editierengithub.com

Al0olo/Agents-village

Dokumentation, READMEs, PR-Beschreibungen und Recherchetexte im Stil dieses Repos schreiben oder bearbeiten. Verwende es immer, wenn du Prosa für Leser:innen erstellst.

Was ist Agents-village?

Dieser Skill definiert einen klaren, konsistenten Schreibstil für alle leserorientierten Texte in einem Repository. Er richtet sich an KI-Agenten und Entwickler:innen, die Dokumentation, READMEs, Pull-Request-Beschreibungen und Forschungsprosa erstellen. Der Skill legt fest, dass jeder Absatz mit dem Kernpunkt beginnt, eine Idee pro Absatz hat und kurze Sätze verwendet. Konkrete Angaben wie Zahlen, Dateien, Befehle oder Namen werden allgemeinen Formulierungen vorgezogen. Prozessbeschreibungen und Selbstbezüge sind in leserorientierten Dokumenten verboten, ebenso Füllwörter wie „es ist wichtig zu beachten“. Tabellen sind nur für Vergleiche erlaubt, Listen nur für Schritte oder parallele Elemente. Unsicherheiten werden genau einmal an der zutreffenden Stelle genannt, zusammen mit einem Hinweis, wie sie aufgelöst werden können. Jedes Verzeichnis benötigt eine `README.md` (Beschreibung für Menschen) und eine `AGENTS.md` (Regeln, die ein Agent umsetzen kann). Beide müssen aktualisiert werden, wenn sich der Zweck oder die Regeln des Verzeichnisses ändern. Leserorientierte Dokumente tragen maximal eine Zeile mit Autorenangabe und ein Datum. Betriebszustände gehören in `docs/HANDOFF.md` und `docs/handoff/LOG.md`. Der Skill schließt mit der Aufforderung, den Text wie eine fremde Person zu lesen und alles zu streichen, was übersprungen würde. Dadurch werden klare, prägnante und benutzerfreundliche Dokumente sichergestellt.

Funktioniert mit~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/Al0olo/Agents-village/tree/HEAD/.claude/skills/docs-style

Installed? Explore more Schreiben & Editieren skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

In Ihrer bevorzugten KI fragen

Öffnet einen neuen Chat, in dem dieser Agent-Skill bereits geladen ist.

Dokumentation

Dokumentationsstil

  • Mit dem Punkt beginnen. Eine Idee pro Absatz. Kurze Sätze.
  • Konkret statt allgemein: eine Zahl, eine Datei, ein Befehl, ein Name.
  • Keine Prozessbeschreibungen oder Selbstbezüge in leserorientierten Dokumenten.
  • Keine Füllwörter: Streiche „es ist wichtig zu beachten“, „um zu“, „robust“, „nutzen“, „umfassend“, „nahtlos“.
  • Tabellen nur für Vergleiche; Listen nur für Schritte oder parallele Elemente.
  • Unsicherheit einmal nennen, wo sie zutrifft, und sagen, was sie auflösen würde.
  • Jedes Verzeichnis hat eine README.md (Was es ist, für Menschen) und eine AGENTS.md (Regeln, nach denen ein Agent handeln kann). Beide aktualisieren, wenn sich der Zweck oder die Regeln des Verzeichnisses ändern.
  • Leserorientierte Dokumente tragen eine Autorenzeile und maximal ein Datum. Betriebszustand gehört in docs/HANDOFF.md und docs/handoff/LOG.md.
  • Lies es noch einmal wie eine fremde Person. Streiche alles, was sie überspringen würde.

Individual skills in this repo

This repo contains 3 individual skills — each has its own dedicated page.

Verwandte Skills