docs-init skill
✓ DoğrulandıKod tabanını inceleyerek ve şablonları doğrulanmış bilgilerle doldurarak bir dokümantasyon yapısı oluşturur.
- GitHub yıldızları
- 8
- Dosyalar
- 3
- Son commit
- 28 Eki 2026
- Lisans
- MIT
- İzin verilen araçlar
- —
docs-init skill ne işe yarar?
Kod tabanını inceleyerek ve şablonları doğrulanmış bilgilerle doldurarak bir dokümantasyon yapısı oluşturur.
Özet, skill'in SKILL.md dosyasından oluşturuldu.
docs-init skilli hakkında
docs-init, dokümantasyonu bulunmayan bir kod tabanı için kapsamlı bir dokümantasyon klasörü kurulmasını sağlar. Yeni projelere başlayan veya docs/ dizini eksik olan mevcut depoları yöneten geliştiriciler için tasarlanmıştır. Araç, projenin özel özelliklerini belirlemek için paket manifestlerini, veritabanı modellerini ve altyapı yapılandırmalarını arayarak kod tabanını inceler.
Teknoloji yığını tanımlandıktan sonra SKILL, architecture.md, onboarding.md ve data-model.md gibi dosyalar oluşturmak için assets/templates/ altındaki şablonları doldurur. Her iddianın varsayımlar yerine gerçek kod bulgularıyla desteklenmesini sağlayarak katı anti-hallucination kurallarını uygular. Ayrıca, Mermaid diyagramlarının doğru şekilde işlendiğinden emin olmak için mmdc aracını kullanarak bunları doğrulamaya çalışır. Bu süreç, mevcut dokümantasyonu güncellemekten ziyade ilk iskelet yapıyı oluşturmak amacıyla tasarlanmıştır.
Bir agent bununla neler yapabilir
- 1Yeni proje dokümantasyonu oluşturmaTamamen yeni bir depo için sıfırdan eksiksiz bir dokümantasyon yapısı başlatın.
- 2Dağıtım ve güvenlik dokümanlarını otomatize etmeDockerfile gibi altyapı dosyaları mevcut olduğunda dağıtım ve güvenlik dokümantasyonu üretin.
- 3Diyagram sözdizimini doğrulamaYeni dokümantasyona dahil edilen Mermaid diyagramlarının sözdizimsel olarak doğru olduğundan emin olun.
Skill'in SKILL.md dosyasından yazılmıştır. Her kullanım durumu oradaki bir alıntı ile kontrol edilir.
docs-init skill nasıl kurulur
Her komut, skill klasörünü istemcinin skills dizinine kopyalar. Yüklemek için istemciyi yeniden başlatın veya yeni bir oturum başlatın.docs-init skill'ini Eklenti uygulamasına kur
/plugin marketplace add mgiovani/cc-arsenal /plugin install cc-arsenal@cc-arsenal-marketplace
docs-init skill'ini Claude Code uygulamasına kur
~/.claude/skills/docs-init/SKILL.md
$ npx degit mgiovani/cc-arsenal/skills/docs-init ~/.claude/skills/docs-initdocs-init skill'ini Claude Code (project) uygulamasına kur
.claude/skills/docs-init/SKILL.md
$ npx degit mgiovani/cc-arsenal/skills/docs-init .claude/skills/docs-initdocs-init skill'ini Codex uygulamasına kur
~/.agents/skills/docs-init/SKILL.md
$ npx degit mgiovani/cc-arsenal/skills/docs-init ~/.agents/skills/docs-initdocs-init skill'ini Gemini CLI uygulamasına kur
~/.gemini/skills/docs-init/SKILL.md
$ npx degit mgiovani/cc-arsenal/skills/docs-init ~/.gemini/skills/docs-initdocs-init skill'ini Claude.ai uygulamasına kur
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
Otomatik kontroller
Çalıştırıldı 15 Kas 2026Tam rapor →Otomatik kontrollerimizi geçti. Bu bir güvenlik denetimi değil: bir ajanın çalıştırmasına izin vermeden önce betikleri okuyun. Kontroller nasıl çalışır · Daha fazla puan için nelerin düzeltileceği
- Kaynak deposu bağlantılı ve erişilebilirmgiovani/cc-arsenal/skills/docs-init is public and reachablegithub.com/mgiovani/cc-arsenal/tree/HEAD/skills/docs-init ↗Geçti
- Açık kaynak lisansı (OSI)MITspdx.org/licenses/MIT.html ↗Geçti
- Son bir yıl içinde commit veya sürüm mevcutLast commit 2026-10-28github.com/mgiovani/cc-arsenal/commits ↗Geçti
- Betiklerde indir-çalıştır veya kimlik bilgisi hırsızlığı yokNo scripts in the skill folderGeçti
- SKILL.md içinde gizli talimat yokNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/mgiovani/cc-arsenal/blob/HEAD/skills/docs-init/SK ↗Geçti
- Önceden izin verilen araçlar sınırlıNo pre-approved tools; the agent asks before using onegithub.com/mgiovani/cc-arsenal/blob/HEAD/skills/docs-init/SK ↗Geçti
- SKILL.md, Agent Skills biçimine uyuyorthe description does not say when to use the skillgithub.com/mgiovani/cc-arsenal/blob/HEAD/skills/docs-init/SK ↗Bulgu
SKILL.md
GitHub'da görüntüleInitialize 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.
Bu becerideki dosyalar
3docs-init skill soruları
docs-init skill'ini Claude Code uygulamasına nasıl kurarım?
npx degit mgiovani/cc-arsenal/skills/docs-init ~/.claude/skills/docs-init komutunu çalıştırın. Claude Code, skill'leri ~/.claude/skills (tüm projeler) veya .claude/skills (tek proje) konumundan yükler ve açıklaması görevle eşleştiğinde skill'i kullanır.
docs-init skill'ini hangi istemciler kullanabilir?
Agent Skills biçimini okuyan her istemci: Claude Code, Codex, Gemini CLI ve claude.ai (ZIP olarak yükleyin). Skill içindeki betikler yalnızca istemcinin kod çalıştırmaya izin verdiği yerlerde çalışır.
Bazı dokümantasyon dosyaları zaten mevcutsa ne olur?
SKILL, docs/ dizinini tarar ve halihazırda var olan hedef dosyaları atlayarak bunları 'skipped' altında listeler ve bunlara dokunmadan önce kullanıcıya sorar.
Araç projem hakkında yanlış bilgi (hallucination) üretir mi?
Hayır, SKILL katı anti-hallucination kurallarını takip eder; her iddianın kod tabanında okunan veya grep ile bulunan bir kaynağa dayanmasını gerektirir ve kanıt bulunamayan bölümleri siler.
Bu araç mevcut dokümantasyonu güncellemek için kullanılabilir mi?
Hayır, bu SKILL özellikle yeni bir docs/ klasörü başlatmak veya iskeletini oluşturmak içindir; mevcut dokümanları yenilemek veya senkronize etmek için docs-update kullanmalısınız.