메뉴
Generate professional software documentation with rigorous research, Kimi K2.5 structured thinking, and Gemini 3 Flash modern design generation. Creates stunning docs that elevate your projects.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
| name | docs |
| description | Generate professional software documentation with rigorous research, Kimi K2.5 structured thinking, and Gemini 3 Flash modern design generation. Creates stunning docs that elevate your projects. |
| metadata | {"clawdbot":"{\"emoji\":\"📚\",\"requires\":{\"bins\":[\"uv\"],\"env\":[]},\"primaryEnv\":\"\",\"install\":[{\"id\":\"uv-brew\",\"kind\":\"brew\",\"formula\":\"uv\",\"bins\":[\"uv\"],\"label\":\"Install uv (brew)\"}]}","legacy_homepage":"https://github.com/topics/documentation-generator"} |
Generate stunning, professional software documentation that elevates your projects above the competition. This skill implements a rigorous 4-phase process powered by AI models for maximum impact.
This skill represents documentation excellence through:
Before generating any documentation, the skill performs exhaustive investigation:
The Kimi K2.5 model (via kimi-code/kimi-for-coding) powers deep reasoning for:
Gemini 3 Flash generates modern, production-ready documentation designs:
uv run {baseDir}/scripts/generate_docs.py --path "/path/to/project" --type "all"
| Type | Description | Best For |
|---|---|---|
readme | Comprehensive README with badges, setup, usage | GitHub repos |
api | Complete API reference with examples | Libraries, SDKs |
guide | User guides and tutorials | Onboarding, how-tos |
website | Full static site (HTML/CSS/JS) | Documentation portals |
all | Complete documentation suite | Full projects |
| Option | Description |
|---|---|
--path, -p | Project root path (required) |
--type, -t | Documentation type: readme/api/guide/website/all |
--output, -o | Output directory |
--theme | Theme: brutalist/swiss/minimal/technical |
--title | Project title (auto-detected if omitted) |
--tagline | One-line description for hero section |
--audience | Target: beginners/intermediate/experts |
--ai-think | Enable Kimi K2.5 reasoning (default: auto) |
--ai-design | Enable Gemini 3 Flash design (default: auto) |
# Full documentation suite with AI enhancement
uv run {baseDir}/scripts/generate_docs.py -p ~/myproject -t all --ai-think --ai-design
# README only with brutalist theme
uv run {baseDir}/scripts/generate_docs.py -p ~/myproject -t readme --theme brutalist \
--title "SuperTool" --tagline "The ultimate solution for modern workflows"
# Complete website documentation with swiss theme
uv run {baseDir}/scripts/generate_docs.py -p ~/project -t website \
--audience experts --title "Enterprise SDK" --theme swiss
# API documentation with technical theme
uv run {baseDir}/scripts/generate_docs.py -p ~/library -t api --theme technical
Configure AI models for optimal performance:
{
"skills": {
"docs": {
"thinkModel": "kimi-code/kimi-for-coding",
"designModel": "gemini-2.0-flash",
"features": {
"reasoning": true,
"designGeneration": true,
"seoOptimization": true,
"interactiveExamples": true
}
}
}
}
| Phase | Model | Purpose | When to Use |
|---|---|---|---|
| Thinking | Kimi K2.5 | Architecture, structure, content strategy | Complex projects, unique requirements |
| Design | Gemini 3 Flash | Visual design, modern layouts | All projects (fast and capable) |
| Fallback | MiniMax-M2.1 | General generation | When specialized models unavailable |
Generated documentation includes:
| Issue | Solution |
|---|---|
| Missing dependencies | Install: uv pip install -r requirements.txt |
| AI models unavailable | Fallback to template-based generation |
| Large projects | Use --type readme first, then expand |
| Custom themes | Place CSS in docs/theme.css for override |
--output--type api for incremental API docsMap of the Tailscale network (tailnet) and how to reach, operate, and deploy to remote machines over it via SSH. Use for any cross-machine task — remote install, deploy, restart, log-check, or file transfer.
Operate nano-core coding delegation. Use for /coder or /coding execution, /coder-plan or /coder_plan planning, natural-language coding approval prompts, delegated runs, run IDs, progress, cancellation, and final-result handling; not for direct coding or automatic delegation.
Diagnose nano-core runtime failures. Use for provider/model errors, Pi launch or skill-discovery failures, Telegram/WhatsApp routing, singleton locks, service state, IPC, SQLite state, scheduler behavior, or per-group logs; not for installation or feature work.
Install or onboard nano-core on a host. Use for first-time installation, prerequisites, runtime selection, provider/channel configuration, daemon setup, upgrades, or doctor checks; not for diagnosing an already-running incident.
Understand and operate nano-core itself. Use for questions about nano-core architecture, behavior, configuration, capabilities, skills, installation, troubleshooting, Telegram administration, or coding delegation; route focused work to the matching nano-core skill.
Configure and operate nano-core through Telegram. Use for bot enablement, main/admin chat claims, trigger routing, command authorization, delivery modes, media intake, polling conflicts, and Telegram-first operation; not for WhatsApp-only or general runtime incidents.