Truc350/WebHomeStay / .agents/skills/basedkit-docs-init
basedkit-docs-init
Verified⚡⚡⚡⚡ Analyze the codebase and create initial documentation
basedkit-docs-init
Use this skill for the BasedKit command /docs:init.
Phase 1: Parallel Codebase Scouting
- Scan the codebase and calculate the number of files with LOC in each directory (skip credentials, cache or external modules directories, such as
.claude,.opencode,.git,tests,node_modules,__pycache__,secrets, etc.) - Target directories that actually exist - adapt to project structure, don't hardcode paths
- Activate
scoutskill to explore the code base and return detailed summary reports to the main agent - Main agent merges scout reports into context summary and delegate to
docs-manageragent to update documentation (next phase)
Phase 2: Documentation Creation (docs-manager Agent)
Pass the gathered file list to docs-manager agent to create initial documentation:
README.md: Update README with initial documentation (keep it under 300 lines)docs/project-overview-pdr.md: Project overview and PDR (Product Development Requirements)docs/codebase-summary.md: Codebase summarydocs/code-standards.md: Codebase structure and code standardsdocs/system-architecture.md: System architecturedocs/project-roadmap.md: Project roadmapdocs/deployment-guide.md[optional]: Deployment guidedocs/design-guidelines.md[optional]: Design guidelines
Use docs/ directory as the source of truth for documentation.
Phase 3: Size Check (Post-Generation)
After docs-manager completes:
- Run
wc -l docs/*.md 2>/dev/null | sort -rnto check LOC - Use
docs.maxLocfrom session context (default: 800) - For files exceeding limit:
- Report which files exceed and by how much
- docs-manager should have already split proactively per Section 6 guidelines
- If still oversized, ask user: split now or accept as-is?
IMPORTANT: Do not start implementing.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization. | Stars: 465k | Updated | Claude CodeCodex | Verified | Install |
| academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |
| claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file). | Stars: 196k | Updated | Claude CodeCodex | Unverified | Install |
| doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |