Dokumentationsplaner
Identifizieren Sie Lücken in der Docs-Seite und erstellen Sie ein priorisiertes Backlog.
Eingaben
- Umfang: Zu bewertender Bereich – alle Docs, ein bestimmter Abschnitt oder ein Feature-Bereich. Standard: alle.
- Signale (optional): GitHub-Issues, Community-Fragen, Support-Threads.
- Wettbewerbskontext (optional): Was Wettbewerber dokumentieren, wir aber nicht.
Prozess
Schritt 1: Aktuelle Docs inventarisieren
Lesen Sie site/src/config/navigation.yml für den vollständigen Navigationsbaum – dies ist die maßgebliche Navigationsquelle für die Astro-Site, geladen über site/astro.config.mjs via site/src/sidebar.ts. Durchsuchen Sie site/src/content/docs/**/*.{md,mdx} nach allen Inhaltsdateien. Klassifizieren Sie jede nach Inhaltstyp (Tutorial, How-to, Referenz, Erklärung, gemischt) und Abdeckungsbereich (Quickstart, Tools, Agents, Multi-Agent, Deployment, usw.).
Schritt 2: Lücken identifizieren
Vergleichen Sie das Inventar mit:
- SDK-Oberfläche: Sind alle Hauptfunktionen dokumentiert? Funktionen ohne Docs-Seiten sind Lücken.
- Diataxis-Vollständigkeit: Existieren für jeden Funktionsbereich Dokumentationen über alle vier Typen hinweg? Eine Funktion mit Referenz aber ohne Tutorial hat eine Lücke.
- Community-Signale: Falls GitHub CLI verfügbar ist, ziehen Sie offene Issues mit dem Label "documentation" aus strands-agents/harness-sdk. Ordnen Sie Fragen bestehenden Docs zu (unklar/schwer zu finden) oder fehlenden Docs (Inhaltslücke).
- Wettbewerbsvergleich (falls angegeben): Was dokumentieren LangChain, CrewAI, Anthropic und OpenAI über gleichwertige Funktionen, was wir nicht tun?
Schritt 3: Priorisieren
Bewerten Sie jede Lücke nach Entwicklerauswirkung und Aufwand:
- P0 (sofort machen): Hohe Auswirkung, jeder Aufwand. Quickstart, Getting-Started, Kernkonzepte.
- P1 (bald machen): Mittlere Auswirkung, geringer Aufwand. Fehlende How-to-Anleitungen für häufige Aufgaben.
- P2 (einplanen): Mittlere Auswirkung, hoher Aufwand. Neue Tutorials, architektonische Erklärungen.
- P3 (Backlog): Geringe Auswirkung. Nischenszenarien, Randfall-Dokumentation.
Schritt 4: Backlog erstellen
Ausgabe als Markdown:
## Docs-Backlog: [Umfang]
**Erstellt:** [Datum]
**Inventarisierte Seiten:** [Anzahl]
**Identifizierte Lücken:** [Anzahl]
### P0: Sofort Machen
- [ ] [Aufgabe] — [Inhaltstyp] — [Zielseite] — [Grund]
### P1: Bald Machen
- [ ] [Aufgabe] — [Inhaltstyp] — [Zielseite] — [Grund]
### P2: Einplanen
- [ ] [Aufgabe] — [Inhaltstyp] — [Zielseite] — [Grund]
### P3: Backlog
- [ ] [Aufgabe] — [Inhaltstyp] — [Zielseite] — [Grund]
### Abdeckungsmatrix
| Funktionsbereich | Tutorial | How-To | Referenz | Erklärung |
|---|---|---|---|---|
| Agent-Grundlagen | Y | ~ | Y | N |
| Benutzerdefinierte Tools | Y | Y | Y | N |
| Multi-Agent | ~ | N | Y | ~ |
### Signalbedingte Erkenntnisse
- [Thema aus Community-Signalen, zugeordnet zu spezifischen Docs-Lücken]
Was Diese Skill NICHT tut
- Schreibt keine Docs (verwenden Sie dafür docs-writer)
- Erfordert keine externen Signalpipelines (funktioniert allein mit lokalem Inventar)
- Erstellt keine Tasks automatisch in externen Tools