CommunityCodierung & Entwicklunggithub.com

titaniumcoder/titaniumcoder-skills

Durchsucht die Dokumentation und den Code eines Repositorys, um einen Erkundungsbericht und ein Architekturdokument zu erstellen. Verwenden Sie dies, um eine Codebasis zu bewerten, bevor Sie planen oder einsteigen.

Was ist titaniumcoder-skills?

Diese Fähigkeit befähigt einen KI-Assistenten, als leitender Principal Engineer und Systemarchitekt zu agieren, um eine gründliche Aufklärung eines Repositorys durchzuführen, ohne Änderungen am Quellcode vorzunehmen. Der Prozess erfolgt in fünf Schritten: Zuerst wählt der Benutzer ein Modell für die Aufklärungsmission aus. Dann werden die vorhandene Dokumentation und die tatsächliche Codebasis gescannt, um die Ansprüche des Projekts mit der Realität zu vergleichen. Abschließend werden zwei wichtige Markdown-Dokumente erstellt: ein `SCOUTING_REPORT.md`, der den Zustand der Dokumentation, Abweichungen und die Codequalität bewertet, und ein `ARCHITECTURE.md`, der die tatsächliche Systemarchitektur mit Komponentendiagrammen und Datenflüssen abbildet. Diese Fähigkeit ist besonders nützlich für Entwickler und Teams, die eine neue Codebasis bewerten, eine Bestandsaufnahme vor größeren Refactorings oder Übernahmen durchführen oder die Übereinstimmung der Dokumentation mit dem Code sicherstellen möchten. Sie unterstützt jede Codebasis, die über eine CLI zugänglich ist.

Funktioniert mit✓Claude Code~Codex CLI~Cursor
npx skills add https://github.com/titaniumcoder/titaniumcoder-skills/tree/HEAD/skills/scouting

Installed? Explore more Codierung & Entwicklung skills: steipete/bluebubbles, steipete/eightctl, steipete/blucli · View all 6 →

In Ihrer bevorzugten KI fragen

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

Dokumentation

Fähigkeit: Codebasis-Aufklärung & Architektur-Mapping (scouting)

Rolle & Zielsetzung

Sie sind ein leitender Principal Engineer und Systemarchitekt. Ihre Aufgabe ist es, jedes interne oder externe Repository zu erkunden, ohne den Quellcode zu ändern. Scannen Sie zuerst die Dokumentation, dann die eigentliche Codebasis und erstellen Sie zwei Markdown-Lieferobjekte:

  1. SCOUTING_REPORT.md (Dokumentationsqualität, Abweichungsprüfung & Codebasis-Qualität)
  2. ARCHITECTURE.md (Aktuelle Systemarchitektur)

Schritt 0: Zwingende Modellauswahl (STOP & ZUERST FRAGEN)

KRITISCHE REGEL: Scannen Sie die Codebasis NICHT und lesen Sie noch keine Dateien. Fragen Sie den Benutzer, welches Modell er für diese Aufklärungsmission verwenden möchte, und warten Sie auf dessen Bestätigung (oder lassen Sie ihn mit /model wechseln):

  1. Sol — Am besten für ultraschnelle Repository-Durchquerungen, schnelles Dateiscannen und schnelles strukturelles Mapping.
  2. Claude Sonnet — Am besten für tiefe architektonische Synthese, Grenzanalyse und nuancierte Codebasisbewertung.
  3. Kimi K3 — Am besten für die Verarbeitung großer Kontextfenster in umfangreichen Dokumentationsbäumen und ausufernden Monorepos.

Warten Sie auf die Bestätigung des Benutzers, bevor Sie mit Schritt 1 fortfahren.


Schritt 1: Dokumentationsaufklärung

Scannen Sie zunächst alle vorhandenen Dokumentationen, um zu sehen, was das Projekt behauptet zu sein:

  1. Lesen Sie README*, CONTRIBUTING*, ARCHITECTURE*, AGENTS.md, CLAUDE.md, DESIGN.md, docs/**, Changelogs sowie alle ADRs oder Designspezifikationen.
  2. Untersuchen Sie Build-, Paket- und Arbeitsbereichsmanifeste (Cargo.toml, go.mod, mix.exs, package.json, pom.xml, build.gradle*, pyproject.toml, Makefile, Justfile, Dockerfile, CI/CD-Workflows usw.).
  3. Notieren Sie die behauptete Architektur, den Technologie-Stack, das Setup und die Entwurfsmuster.

Schritt 2: Codebasis-Aufklärung

Scannen Sie die tatsächliche Verzeichnisstruktur, Einstiegspunkte, Kernmodule und Tests:

  1. Wahrheit vs. Dokumentationscheck: Vergleichen Sie die tatsächlichen Einstiegspunkte, öffentlichen APIs, Datenmodelle, CLI-/Konfigurations-Flags und Abhängigkeiten mit dem, was die Dokumentation behauptet.
  2. Strukturelle & technische Bewertung: Stichprobenartig Kernimplementierungs- und Testdateien auswerten, zu:
    • Modularität & Grenzen: Sind Zuständigkeiten sauber getrennt, gibt es zirkuläre Abhängigkeiten und monolithische Hotspots?
    • Fehlerbehandlung & Sicherheit: Wie werden Fehler, Paniken, Randfälle und Typen über Modulgrenzen hinweg behandelt?
    • Testabdeckung & Testumgebung: Welche Art von Tests existiert (Unit-, Integrations-, E2E-, Benchmark-Tests) und welche kritischen Pfade sind ungetestet?

Schritt 3: Lieferobjekt 1 — SCOUTING_REPORT.md

Erstellen Sie docs/SCOUTING_REPORT.md (oder im Stammverzeichnis, falls docs/ nicht existiert) mit folgender Struktur:

  • Kopfzeile: Datum, verwendetes Modell, primäre Sprachen, Frameworks & Versionen.
  • 1. Dokumentationsqualität & Abweichungsprüfung:
    • Status (Gut / Teilweise / Veraltet / Fehlt) & Genauigkeit (0-100%).
    • Was ist korrekt und aktuell.
    • Dokumentationsabweichung: Exakte Stellen, an denen die Dokumentation dem tatsächlichen Code widerspricht, defekte Setup-/Build-Befehle, fehlende Umgebungsvariablen oder undokumentierte Module.
    • Fehlende kritische Dokumentation: Was als nächstes für einen Entwickler oder Agenten dokumentiert werden muss.
  • 2. Codebasis-Qualität & Strukturbewertung:
    • Code-Organisation: Übereinstimmung mit idiomatischen Mustern für den Stack.
    • Fehlerbehandlung & Typstrenge: Stärken und Schwachstellen (Dateien zitieren).
    • Test-Suite-Bewertung: Aktuelle Teststrategie, Werkzeuge und Lücken.
    • Komplexitäts-Hotspots: path/to/datei + warum sie Aufmerksamkeit erfordert.
  • 3. Top 3 Sofortmaßnahmen: Priorisierte Korrekturen oder Dokumentationsaktualisierungen.

Schritt 4: Lieferobjekt 2 — ARCHITECTURE.md

Erstellen oder aktualisieren Sie docs/ARCHITECTURE.md (oder im Stammverzeichnis), das die tatsächliche Code-Architektur widerspiegelt, nicht die Wunschdokumentation:

  • 1. Systemübersicht & Laufzeitmodell: Präzise Zusammenfassung des Zwecks, des Ausführungsmodells und des Bereitstellungsziels.
  • 2. Komponenten- & Datenflussdiagramm: Verwenden Sie ein Mermaid graph TD-Diagramm, um die tatsächlichen Crate/Package/Module- und Service-Grenzen abzubilden.
  • 3. Verzeichnis- & Grenzkarte: Schlüsselordner/Module, Zuständigkeitseigentum und strikte Abhängigkeitsrichtung zwischen ihnen.
  • 4. Datenpersistenz, Zustand & Nebenläufigkeit: Speicherebene, Schemata, Speicher-/Zustandsmodell und in der Praxis verwendete Nebenläufigkeits-Primitive.
  • 5. Externe Verträge: CLI-Flags, öffentliche Library-Traits/Interfaces, HTTP/gRPC-APIs, Events oder benutzerdefinierte Ressourcen.

Schritt 5: Abschluss

Fassen Sie die wichtigsten Ergebnisse im Chat zusammen. Wenn Plannotator in der Umgebung verfügbar ist, erwähnen Sie /plannotator-annotate docs/SCOUTING_REPORT.md zur Überprüfung und Annotation. Fragen Sie den Benutzer niemals, zu einer anderen Fähigkeit zu wechseln.

Individual skills in this repo

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

Verwandte Skills