Skill docs-init
✓ VerifiedMelakukan bootstrap pada struktur dokumentasi dengan mengeksplorasi codebase dan mengisi template dengan informasi yang telah terverifikasi.
- Bintang GitHub
- 8
- File
- 3
- Commit terakhir
- 28 Okt 2026
- Lisensi
- MIT
- Tool yang diizinkan
- —
Apa fungsi skill docs-init?
Melakukan bootstrap pada struktur dokumentasi dengan mengeksplorasi codebase dan mengisi template dengan informasi yang telah terverifikasi.
Ringkasan dibuat dari SKILL.md skill ini.
Tentang skill docs-init
docs-init memungkinkan Anda menyiapkan folder dokumentasi yang komprehensif untuk codebase yang belum memiliki dokumentasi. Tool ini dirancang untuk developer yang sedang memulai proyek baru atau mengelola repositori yang belum memiliki direktori docs/. Tool ini mengeksplorasi codebase dengan mencari package manifests, database models, dan konfigurasi infrastruktur untuk menentukan karakteristik spesifik proyek Anda.
Setelah tech stack teridentifikasi, skill ini akan mengisi template dari assets/templates/ untuk membuat file seperti architecture.md, onboarding.md, dan data-model.md. Skill ini mengikuti aturan anti-halusinasi yang ketat, memastikan setiap klaim didukung oleh temuan kode aktual dan bukan sekadar asumsi. Tool ini juga mencoba memvalidasi diagram Mermaid menggunakan tool mmdc untuk memastikan diagram tersebut dapat dirender dengan benar. Proses ini ditujukan untuk scaffolding awal, bukan untuk memperbarui dokumentasi yang sudah ada.
Apa yang bisa dilakukan agent dengannya
- 1Scaffold dokumentasi proyek baruInisialisasi struktur dokumentasi yang lengkap untuk repositori yang benar-benar baru dari awal.
- 2Otomatisasi dokumentasi deployment dan keamananMenghasilkan dokumentasi deployment dan keamanan ketika file infrastruktur seperti Dockerfile tersedia.
- 3Verifikasi sintaks diagramMemastikan bahwa setiap diagram Mermaid yang disertakan dalam dokumentasi baru memiliki sintaks yang benar.
Ditulis dari SKILL.md milik skill tersebut. Setiap use case diverifikasi dengan kutipan darinya.
Cara install skill docs-init
Setiap perintah menyalin folder skill ke direktori skills client. Restart client atau mulai sesi baru untuk memuatnya.Install skill docs-init di Plugin
/plugin marketplace add mgiovani/cc-arsenal /plugin install cc-arsenal@cc-arsenal-marketplace
Install skill docs-init di Claude Code
~/.claude/skills/docs-init/SKILL.md
$ npx degit mgiovani/cc-arsenal/skills/docs-init ~/.claude/skills/docs-initInstall skill docs-init di Claude Code (project)
.claude/skills/docs-init/SKILL.md
$ npx degit mgiovani/cc-arsenal/skills/docs-init .claude/skills/docs-initInstall skill docs-init di Codex
~/.agents/skills/docs-init/SKILL.md
$ npx degit mgiovani/cc-arsenal/skills/docs-init ~/.agents/skills/docs-initInstall skill docs-init di Gemini CLI
~/.gemini/skills/docs-init/SKILL.md
$ npx degit mgiovani/cc-arsenal/skills/docs-init ~/.gemini/skills/docs-initInstall skill docs-init di Claude.ai
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
Pengecekan otomatis
Berjalan 15 Nov 2026Laporan lengkap →Lolos cek otomatis kami. Ini bukan audit keamanan: baca skripnya sebelum membiarkan agent menjalankannya. Cara kerja checks · Yang perlu diperbaiki untuk menambah poin
- Source repository terhubung dan dapat dijangkaumgiovani/cc-arsenal/skills/docs-init is public and reachablegithub.com/mgiovani/cc-arsenal/tree/HEAD/skills/docs-init ↗Lolos
- Lisensi open source (OSI)MITspdx.org/licenses/MIT.html ↗Lolos
- Ada commit atau release dalam satu tahun terakhirLast commit 2026-10-28github.com/mgiovani/cc-arsenal/commits ↗Lolos
- Skrip tanpa unduh-lalu-jalankan atau pencurian kredensialNo scripts in the skill folderLolos
- Tidak ada instruksi tersembunyi di SKILL.mdNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/mgiovani/cc-arsenal/blob/HEAD/skills/docs-init/SK ↗Lolos
- Tool yang diizinkan otomatis dibatasiNo pre-approved tools; the agent asks before using onegithub.com/mgiovani/cc-arsenal/blob/HEAD/skills/docs-init/SK ↗Lolos
- SKILL.md mengikuti format Agent Skillsthe description does not say when to use the skillgithub.com/mgiovani/cc-arsenal/blob/HEAD/skills/docs-init/SK ↗Temuan
SKILL.md
Lihat di GitHubInitialize 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.
Berkas dalam skill ini
3Pertanyaan seputar skill docs-init
Bagaimana cara install skill docs-init di Claude Code?
Jalankan npx degit mgiovani/cc-arsenal/skills/docs-init ~/.claude/skills/docs-init. Claude Code memuat skill dari ~/.claude/skills (semua proyek) atau .claude/skills (satu proyek) dan menggunakan skill saat deskripsinya cocok dengan tugas.
Client mana saja yang bisa menggunakan skill docs-init?
Client apa pun yang membaca format Agent Skills: Claude Code, Codex, Gemini CLI, dan claude.ai (unggah sebagai ZIP). Script dalam skill hanya berjalan di client yang mengizinkan eksekusi kode.
Apa yang terjadi jika beberapa file dokumentasi sudah ada?
SKILL ini akan memindai direktori docs/ dan melewati file target yang sudah ada, mencantumkannya di bawah kategori 'skipped' dan meminta konfirmasi Anda sebelum melakukan perubahan.
Apakah tool ini akan berhalusinasi mengenai proyek saya?
Tidak, skill ini mengikuti panduan anti-halusinasi yang ketat, di mana setiap klaim harus dapat ditelusuri ke sesuatu yang dibaca atau di-grep di dalam codebase, serta menghapus bagian yang tidak ditemukan buktinya.
Bisakah tool ini digunakan untuk memperbarui dokumentasi yang sudah ada?
Tidak, skill ini khusus untuk inisialisasi atau scaffolding folder docs/ yang baru; Anda sebaiknya menggunakan docs-update untuk menyegarkan atau menyinkronkan dokumentasi yang sudah ada.