docs-init Skill
✓ VerifiziertErstellt eine Dokumentationsstruktur, indem die Codebase analysiert und Templates mit verifizierten Informationen befüllt werden.
- GitHub Stars
- 8
- Dateien
- 3
- Letzter Commit
- 28. Okt. 2026
- Lizenz
- MIT
- Erlaubte Tools
- —
Was macht der docs-init Skill?
Erstellt eine Dokumentationsstruktur, indem die Codebase analysiert und Templates mit verifizierten Informationen befüllt werden.
Zusammenfassung erzeugt aus der SKILL.md des Skills.
Über den docs-init skill
docs-init ermöglicht es dir, einen umfassenden Dokumentationsordner für eine undokumentierte Codebase aufzubauen. Es ist für Entwickler gedacht, die neue Projekte starten oder bestehende Repositories verwalten, denen ein docs/ Verzeichnis fehlt. Das Tool durchsucht die Codebase nach Package-Manifesten, Datenbank-Modellen und Infrastruktur-Konfigurationen, um die spezifischen Merkmale des Projekts zu ermitteln.
Sobald der Tech-Stack identifiziert wurde, befüllt der Skill Templates aus assets/templates/, um Dateien wie architecture.md, onboarding.md und data-model.md zu erstellen. Dabei werden strikte Anti-Halluzinations-Regeln angewendet, um sicherzustellen, dass jede Aussage auf tatsächlichen Code-Fundstellen basiert und nicht auf Annahmen. Zudem versucht das Tool, Mermaid-Diagramme mit dem mmdc Tool zu validieren, damit sie korrekt gerendert werden. Dieser Prozess ist für das initiale Scaffolding gedacht, nicht für das Update bestehender Dokumentation.
Was ein agent damit machen kann
- 1Scaffolding für neue ProjektdokumentationInitialisiere eine vollständige Dokumentationsstruktur für ein brandneues Repository von Grund auf.
- 2Automatisierung von Deployment- und Security-DocsErstelle Deployment- und Security-Dokumentation, sofern Infrastruktur-Dateien wie Dockerfiles vorhanden sind.
- 3Verifizierung der Diagramm-SyntaxStelle sicher, dass alle in der neuen Dokumentation enthaltenen Mermaid-Diagramme syntaktisch korrekt sind.
Geschrieben basierend auf dem SKILL.md des skills. Jeder use case wurde gegen ein zitat daraus geprüft.
So installierst du den docs-init Skill
Jeder Befehl kopiert den Skill-Ordner in das Skills-Verzeichnis des Clients. Starte den Client neu oder beginne eine neue Session, um ihn zu laden.Den docs-init Skill in Plugin installieren
/plugin marketplace add mgiovani/cc-arsenal /plugin install cc-arsenal@cc-arsenal-marketplace
Den docs-init Skill in Claude Code installieren
~/.claude/skills/docs-init/SKILL.md
$ npx degit mgiovani/cc-arsenal/skills/docs-init ~/.claude/skills/docs-initDen docs-init Skill in Claude Code (project) installieren
.claude/skills/docs-init/SKILL.md
$ npx degit mgiovani/cc-arsenal/skills/docs-init .claude/skills/docs-initDen docs-init Skill in Codex installieren
~/.agents/skills/docs-init/SKILL.md
$ npx degit mgiovani/cc-arsenal/skills/docs-init ~/.agents/skills/docs-initDen docs-init Skill in Gemini CLI installieren
~/.gemini/skills/docs-init/SKILL.md
$ npx degit mgiovani/cc-arsenal/skills/docs-init ~/.gemini/skills/docs-initDen docs-init Skill in Claude.ai installieren
npx degit mgiovani/cc-arsenal/skills/docs-init docs-init && zip -r docs-init.zip docs-init # claude.ai → Customize → Skills → + → Create skill → Upload a skill → docs-init.zip
Automatisierte Checks
Geluften am 15. Nov. 2026Vollständiger Bericht →Hat unsere automatischen Prüfungen bestanden. Das ist kein Sicherheitsaudit: Lesen Sie die Skripte, bevor ein Agent sie ausführt. Wie die Checks funktionieren · Was du für mehr Punkte verbessern kannst
- Source Repository verknüpft und erreichbarmgiovani/cc-arsenal/skills/docs-init is public and reachablegithub.com/mgiovani/cc-arsenal/tree/HEAD/skills/docs-init ↗Bestanden
- Open Source Lizenz (OSI)MITspdx.org/licenses/MIT.html ↗Bestanden
- Commit oder Release im letzten JahrLast commit 2026-10-28github.com/mgiovani/cc-arsenal/commits ↗Bestanden
- Keine Download-und-Ausführen-Muster oder Zugangsdatendiebstahl in SkriptenNo scripts in the skill folderBestanden
- Keine versteckten Anweisungen in SKILL.mdNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/mgiovani/cc-arsenal/blob/HEAD/skills/docs-init/SK ↗Bestanden
- Vorab erlaubte Tools sind eingeschränktNo pre-approved tools; the agent asks before using onegithub.com/mgiovani/cc-arsenal/blob/HEAD/skills/docs-init/SK ↗Bestanden
- SKILL.md folgt dem Agent-Skills-Formatthe description does not say when to use the skillgithub.com/mgiovani/cc-arsenal/blob/HEAD/skills/docs-init/SK ↗Befund
SKILL.md
Auf GitHub ansehenInitialize Project Documentation
Bootstrap a docs/ structure for a project with little or no existing documentation. Only generate what the codebase actually evidences.
Anti-hallucination guidelines
Every claim in generated docs must trace to something read or grepped in this run:
- Verify a file/directory exists before referencing it.
- Get counts from
ls/find/grep, never estimate. - Quote real function/class/table names, not assumed ones.
- An empty directory is not a feature, don't document it.
- If a claim can't be verified, drop it rather than guess.
Workflow
1. Explore the codebase
Find: source directories with actual code, package manager files (package.json, pyproject.toml, go.mod, Cargo.toml, ...), database/ORM files, infrastructure configs (Docker, k8s, Terraform), and any existing docs/. See Detection Commands below for the exact patterns.
If a Task/subagent tool is available, delegate this to an Explore agent with that scope. Otherwise run the same grep/find commands inline and Read each hit: the result must be the same either way.
Verify every finding before using it: read the package manifest, read the model file, confirm a directory has real files inside it, not just an empty folder.
2. Detect project characteristics
From the exploration, determine: language/framework stack, project type (web app, CLI, library, service), whether a database/ORM is present, and whether infrastructure/deployment configs exist. These characteristics drive which doc types Phase 3 decides to generate.
3. Decide which docs to generate
- Always:
docs/architecture.md,docs/onboarding.md,docs/adr/0001-record-architecture-decisions.md(Nygard-format meta-ADR, generate inline, no template file) - If a database/ORM was found:
docs/data-model.md - If deployment configs were found (Dockerfile, k8s manifest, CI workflow, IaC):
docs/deployment.md,docs/security.md - If the project looks collaborative (multiple contributors in
git log, an open-source license, no existing CONTRIBUTING):docs/contributing.md,docs/rfc/directory
Don't generate a doc type with no supporting evidence: an empty data-model.md for a stateless CLI is worse than no file at all.
4. Check for existing docs
Scan docs/. For any target file that already exists, do not overwrite it: list it under "skipped" and ask the user before touching it. This skill is safe to rerun: by default it only fills gaps.
5. Populate templates
Templates live in assets/templates/ (see reference table below). For each one you're using:
- Grep it for its actual placeholder set:
grep -oE '\{\{[A-Z_0-9]+\}\}' assets/templates/<name>.md | sort -u - Map every placeholder to a value from step 1/2's verified findings. Never leave a placeholder as a literal
{{TOKEN}}in the output. - Templates mark some sections as conditional with an HTML comment ("delete if...", "only if evidenced"). Where the codebase gives no evidence for that section, delete the whole section (heading included, not just the placeholder text).
- After writing the file, grep it for
\{\{[A-Z_0-9]+\}\}again. Zero matches. If any remain, resolve or delete them before moving on.
Worked example (a FastAPI + PostgreSQL service):
$ grep -oE '\{\{[A-Z_0-9]+\}\}' assets/templates/architecture.md | sort -u
{{COMPONENT_DEPENDENCIES}}
{{COMPONENT_DESCRIPTION}}
{{COMPONENT_NAME}}
{{DATA_FLOW}}
{{DATE}}
{{DEPLOYMENT_SUMMARY}}
...
Map each to a verified finding: {{TECHNOLOGY_STACK}} becomes "Python 3.12, FastAPI 0.115, PostgreSQL 16 via SQLAlchemy", read from pyproject.toml and the model files, not assumed. If security.md's Compliance section has no GDPR/HIPAA evidence in the codebase (no consent flow, no PHI handling), delete that whole section rather than fill it with a guess.
6. Write the files
Create docs/ (and docs/adr/, docs/rfc/ if needed). Write each file that isn't being skipped.
7. Validate the diagrams render
Skip if none of the files you wrote has a ```mermaid block. Otherwise you need mmdc: install with npm i -g @mermaid-js/mermaid-cli, or run it ad hoc by defining mmdc() { npx -y -p @mermaid-js/mermaid-cli mmdc "$@"; } first. If Chromium refuses to launch in a sandbox, add -p with a puppeteer config of {"args":["--no-sandbox"]}.
Run this on the files you wrote; each FAIL <name>-N.mmd names the doc and the Nth mermaid block in it:
d=$(mktemp -d)
for md in <the docs/ files you wrote>; do
awk -v out="$d/${md//\//__}" '/^```mermaid/{f=out "-" ++n ".mmd"; next} /^```/{f=""} f{print > f}' "$md"
done
for f in "$d"/*.mmd; do mmdc -q -i "$f" -o "${f%.mmd}.svg" || echo "FAIL $f"; done
Fix each failing block using its parser error, then re-run until nothing prints FAIL. Cap at 3 rounds, then report the blocks that still fail. If mmdc can't be installed (no Node, offline), say so in the report and fall back to a careful syntax review of each diagram.
8. Report
List what was created, what was skipped (already existed), diagram validation result (rendered, or still failing, or unvalidated), and next steps.
Template Reference
| Document | Template | Generated when |
|---|---|---|
| Architecture | architecture.md |
always |
| Onboarding | onboarding.md |
always |
| First ADR | inline (Nygard format) | always |
| Data Model | data-model.md |
database/ORM detected |
| Deployment | deployment.md |
deployment config detected |
| Security | security.md |
deployment config detected |
| Contributing | contributing.md |
collaborative project |
Detection Commands
Run these directly (or hand them to the Explore agent from step 1):
# Language/framework
find . -name "package.json" -o -name "pyproject.toml" -o -name "go.mod" -o -name "Cargo.toml" | head -5
# Database/ORM
find . -name "*models.py" -o -name "*schema.prisma" -o -name "*entity.ts" | head -5
# Infrastructure
find . -name "Dockerfile" -o -name "docker-compose.yml" -o -name "*.k8s.yaml" | head -5
# Project name and description
basename "$(git rev-parse --show-toplevel 2>/dev/null || pwd)"
head -20 README.md 2>/dev/null
Usage Examples
docs-init
docs-init for Python FastAPI microservice
docs-init for Next.js SaaS application
Example Output
Documentation Initialization Complete
Created:
docs/architecture.md - System architecture overview
docs/onboarding.md - Developer onboarding guide
docs/adr/0001-record-architecture-decisions.md - Meta-ADR
docs/data-model.md - Database schema (SQLAlchemy detected)
docs/deployment.md - Deployment guide (Docker detected)
Skipped (already exists):
docs/contributing.md
Next steps:
1. Review and customize the generated docs
2. docs-diagram er / docs-diagram arch for standalone diagrams
3. docs-adr "Decision Title" for future ADRs
Notes
- Safe to rerun: only fills gaps, asks before overwriting existing files.
- User-supplied context (e.g. "for a FastAPI microservice") steers detection but doesn't replace verification: still confirm the stack from the actual files.
Dateien in diesem Skill
3docs-init Skill-Fragen
Wie installiere ich den docs-init Skill in Claude Code?
Führe npx degit mgiovani/cc-arsenal/skills/docs-init ~/.claude/skills/docs-init aus. Claude Code lädt Skills aus ~/.claude/skills (alle Projekte) oder .claude/skills (ein Projekt) und nutzt einen Skill, wenn seine Beschreibung zur Aufgabe passt.
Welche Clients können den docs-init Skill nutzen?
Jeder Client, der das Agent Skills-Format liest: Claude Code, Codex, Gemini CLI und claude.ai (als ZIP hochladen). Skripte im Skill laufen nur dort, wo der Client Codeausführung erlaubt.
Was passiert, wenn bereits Dokumentationsdateien existieren?
Der Skill scannt das docs/ Verzeichnis und überspringt alle Zieldateien, die bereits vorhanden sind. Diese werden unter 'skipped' aufgelistet, und der User wird gefragt, bevor Änderungen vorgenommen werden.
Wird das Tool Informationen über mein Projekt halluzinieren?
Nein, der Skill folgt strengen Anti-Halluzinations-Richtlinien. Jede Aussage muss auf etwas zurückgeführt werden, das im Code gelesen oder per grep gefunden wurde. Abschnitte ohne Belege werden gelöscht.
Kann dieses Tool verwendet werden, um bestehende Dokumentation zu aktualisieren?
Nein, dieser Skill ist speziell für das Initialisieren oder Scaffolding eines neuen docs/ Ordners gedacht; für das Aktualisieren oder Synchronisieren bestehender Dokumentation solltest du docs-update nutzen.