CommunitySchreiben & Editierengithub.com

NOC Living Docs

Protokoll für lebende Dokumentation und Codex-Skill, um KI-gestützte Codeänderungen, Anforderungen, Status, Leitplanken, Tests und Änderungsaufzeichnungen synchron zu halten.

Was ist NOC Living Docs?

Dieser Skill, NOC Living Docs, dient als ausführbares Projektspeicher-System. Er ist für Entwickler konzipiert, die KI-Assistenten wie Claude Code, Cursor oder Codex verwenden, um sicherzustellen, dass während des gesamten Softwareentwicklungszyklus Code, Anforderungen und Dokumentation konsistent bleiben. Der Skill funktioniert, indem er den KI-Agenten durch das `noc_docs/`-Verzeichnis führt, nur die relevanten Dokumente für eine bestimmte Aufgabe liest und diese automatisch aktualisiert, wenn sich Code oder Absichten ändern. Er unterstützt Aufgaben wie das Initialisieren oder Migrieren der `noc_docs/`, das Verwalten neuer Funktionen, Fehlerbehebungen, Refactorings, API-Änderungen und Sicherheitsupdates. Der Workflow umfasst das Identifizieren des betroffenen Features über eine Feature-Map, das Ausführen von noc-CLI-Befehlen zum Planen der Arbeit, das Lesen der minimal erforderlichen Dokumente (z. B. agent-guide.md, requirements.md) und das anschließende Aktualisieren von status.md, test-record.md, change-record.md und guardrails.md. Er enthält klare Abbruchregeln, um Konflikte mit Leitplanken oder Anforderungen zu verhindern, und definiert eine präzise Definition of Done, die die Übereinstimmung von Code- und Dokumentänderungen sowie die Ausführung aller erforderlichen Indizierungs- und Prüfaufgaben sicherstellt.

Funktioniert mit~Claude Code✓Codex CLI~Cursor
npx skills add SmallNoc/noc-living-docs

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

Projekt Living Docs

Nutze NOC Living Docs als ausführbares Projektgedächtnis. Leite die Arbeit über noc_docs/, lies nur die betroffenen Dokumente, aktualisiere die Living Docs bei Änderungen von Code oder Absicht und überprüfe abschließend mit der CLI.

Trigger

Verwende diesen Skill für:

  • Initialisieren oder Migrieren von noc_docs/
  • Besprechen einer Anforderung und anschließendes Ändern von Code
  • neue Funktionen, Fehlerbehebungen, Refactorings, API-/Daten-/Sicherheits-/Bereitstellungsänderungen
  • Prüfen, ob Codeänderungen Dokumentationsupdates benötigen
  • Abfragen oder Überprüfen der Projekt-Living-Docs

Nicht verwenden für allgemeine Fragen, die kein Projektgedächtnis, Codeverhalten, Anforderungen, Leitplanken, Tests oder die NOC-Dokumentation betreffen.

Ausführung

  1. Identifiziere das betroffene Feature/Domain aus der Anfrage, den geänderten Pfaden und noc_docs/.living-docs/feature-map.json.
  2. Führe einen Arbeitsplan aus, wenn Code sich ändern könnte:
python scripts/noc.py work /path/to/project --feature <feature> --intent "<vereinbarte Anforderung>"

Verwende --path <code/path> wenn Pfade eindeutiger als Feature-Namen sind.

  1. Lies die kleinsten relevanten Docs: agent-guide.md, requirements.md, status.md, guardrails.md, test-record.md plus Domain-Leitplanken, falls vorhanden.
  2. Schreibe bestätigte neue/geänderte Absicht in requirements.md; unsichere Diskussionen in notes.md.
  3. Ändere Code.
  4. Aktualisiere status.md, test-record.md, change-record.md und guardrails.md, wenn sich Verhalten, Verifikation, wichtige Änderungen oder Constraints geändert haben.
  5. Führe python scripts/noc.py index <project> nach Docs-, Feature- oder Mapping-Änderungen aus.
  6. Führe python scripts/noc.py check <project> --staged --warn-only vor dem Commit aus, wenn Git verfügbar ist.

Ausführliche Workflow-Regeln findest du in references/workflow.md.

Nicht fortfahren

Halte an und frage den Benutzer, bevor du Code bearbeitest, wenn:

  • die Anfrage mit guardrails.md oder Domain-Leitplanken kollidiert
  • die Produktabsicht mit requirements.md konfligiert und die gewünschte Richtung unklar ist
  • das betroffene Feature/Domain nicht identifiziert werden kann und die Änderung nicht offensichtlich global ist
  • erforderliche Dokumente fehlen und die Aufgabe von unbekannten Anforderungen oder Constraints abhängt
  • der Benutzer verlangt, Anforderungen stillschweigend an den aktuellen Code anzupassen
  • die Änderung Sicherheit, Berechtigungen, Abrechnung, Datenverlust, Migrationen oder öffentliche API-Verträge betrifft und das gewünschte Verhalten mehrdeutig ist

Definition of Done

Eine Aufgabe mit diesem Skill ist nur dann erledigt, wenn:

  • betroffene Docs über Feature-Map, Pfade oder expliziten Feature-Namen identifiziert wurden
  • erforderliche Docs gelesen oder fehlende Docs benannt wurden
  • Code- und Dokumentänderungen übereinstimmen
  • requirements.md nur für beabsichtigte Verhaltensänderungen aktualisiert wurde
  • status.md das aktuelle Verhalten nach Codeänderungen widerspiegelt
  • test-record.md die Verifikation festhält oder erklärt, warum keine Verifikation durchgeführt wurde
  • change-record.md wichtige Implementierungsänderungen dokumentiert
  • Indizierungen/Prüfungen durchgeführt oder mit Begründung übersprungen wurden

Abschließendes Antwortformat

Beende mit:

NOC Living Docs:
- docs gelesen:
- docs aktualisiert:
- docs absichtlich unverändert:
- ausgeführte Befehle:
- ausgeführte Tests:
- verbleibende Risiken:

Halte die Listen kurz. Verwende keine, wenn eine Kategorie nicht zutrifft.

Referenzen

  • references/workflow.md: Modusauswahl, Fallback-Regeln, Konflikthandhabung, Arbeitszyklus
  • references/feature-doc-template.md: Inhalt eines Feature-Dokuments
  • references/domain-mode-guide.md: Wann und wie der Domain-Modus verwendet wird
  • references/codex-prompts.md: Empfohlene Benutzer-Prompts für Codex-Plan-/Ziel-/Code-Workflows

Verwandte Skills