doc-generator
Use this skill when the user wants to generate, update, or improve usage documentation for a project, file, component, SDK, module, or function based on source code.
What this skill does
# Doc Generator Skill ## Purpose This skill analyzes codebases, files, and symbols, then generates practical usage documentation. The goal is not only to explain code, but to produce documentation that helps users understand: - what this code/module does - when it should be used - how to use it correctly - what constraints or risks exist - what common misuse patterns should be avoided This skill is intended for: - component libraries - SDKs - utility libraries - infrastructure libraries - business shared modules - core project modules ## Supported Targets This skill supports the following target scopes: 1. **project-level** - entire repository - package - component library - SDK project 2. **file-level** - single file - module file - entry file - service / manager / composable / hook file 3. **symbol-level** - function - method - class - component - hook / composable - exported constant / config factory ## Core Principles 1. Documentation must be **usage-oriented**, not just implementation-oriented. 2. Prefer explaining **how to use**, **when to use**, and **what to watch out for**. 3. Prefer **minimal runnable examples** over abstract explanation. 4. Do not invent behavior that cannot be supported by code evidence. 5. Clearly mark uncertainty when behavior cannot be fully confirmed from source. 6. Distinguish between: - confirmed by code - high-confidence inference - requires verification 7. Generated docs must be readable by engineers who did not write the code. 8. When existing docs already exist, prefer **update / improve / align**, not blindly overwrite. ## Default Workflow When invoked, follow this workflow: 1. Determine target scope: - project - file - symbol 2. Determine documentation intent: - readme - usage-guide - api-reference - module-guide - best-practices - faq - migration-guide - update-existing-doc 3. Inspect available evidence: - folder structure - exports - type definitions - comments - function signatures - call relationships - example code - tests - existing documentation - package metadata - config files 4. Build understanding: - responsibility - public surface - dependencies - usage flow - constraints - edge cases - risks - example patterns 5. Generate documentation in the requested format. 6. Run quality checks before finalizing. ## Required Behavior ### Always do - explain the target’s responsibility in plain language - identify public-facing APIs or exposed usage surfaces - describe suitable scenarios and, if possible, unsuitable scenarios - include at least one usage example when enough evidence exists - include caveats / limitations / risk notes when relevant - explicitly state uncertainty when evidence is insufficient ### Never do - fabricate business context - fabricate runtime behavior - claim compatibility not supported by evidence - describe internal assumptions as facts - output vague filler without concrete value - rewrite code as documentation without interpretation ## Documentation Style Documentation should be: - clear - structured - practical - concise but sufficiently informative - focused on real usage Prefer: - direct statements - scenario-based explanation - minimal examples - explicit constraints - actionable warnings Avoid: - empty praise - generic summaries - repeating code names without interpretation - over-explaining obvious syntax ## Uncertainty Policy When the code does not provide enough evidence: - mark the statement as **Inference** - or mark as **Needs Verification** Examples: - Confirmed: visible directly from exports, types, or implementation - Inference: strongly suggested by naming, call chain, or surrounding structure - Needs Verification: depends on runtime, external system, hidden contract, or business rules ## Output Preference Unless the user specifies otherwise: - project-level → produce `README` or `usage guide` - file-level → produce `module guide` - symbol-level → produce `API reference` ## Reference Files Read and follow: - `references/overview.md` - `references/input-schema.md` - `references/output-rules.md` - `references/analysis-rules.md` - `references/doc-templates.md` - `references/quality-checklist.md` ## Success Criteria This skill succeeds when the produced documentation helps a new engineer answer: - What is this for? - When should I use it? - How do I use it? - What do I need before using it? - What can go wrong? - What is the safest recommended usage pattern?
Related in Design
contribute
IncludedLocal-only OSS contribution command center. Auto-refreshes the user's in-flight PR and issue state on invoke so conversations start with full context — no need to brief Claude on what's in flight. Helps the user find issues to contribute to on GitHub, builds per-repo dossiers of what each upstream expects (CLA, DCO, branch convention, AI policy, draft-first, review bots, issue templates), runs deterministic gates before any external action so AI-assisted contributions don't reach maintainers as slop. State is markdown-only: candidate files at ~/.contribute-system/candidates/, repo dossiers at ~/.contribute-system/research/, append-only event log at ~/.contribute-system/log.jsonl. No database, no cloud calls. Use when the user asks about their PRs / issues / contributions, wants to find new work to take on, claim an issue, build/refresh a repo's dossier, or draft a Design Issue or PR. Trigger with "/contribute", "what's my PR status", "find a contribution", "claim issue X", "draft a Design Issue for Y", "refresh dossier for Z".
architectural-analysis
IncludedUser-triggered deep architectural analysis of a codebase or scoped subtree across eight modes — information architecture, data flow, integration points, UI surfaces, interaction patterns, data model, control flow, and failure modes. This skill should be used when the user asks to "diagram this codebase," "map the architecture," "show the data flow," "give me an ERD," "trace control flow," "find the integration points," "verify the layout pattern," "audit the UX architecture," or any similar request whose primary deliverable is mermaid diagrams plus cited reports under docs/architecture/. Dispatches haiku/sonnet sub-agents in parallel for per-mode exploration, then verifies every citation mechanically before any node lands in a diagram. Not for one-off prose explanations of code (use code-explanation) or for high-level system design from scratch (use system-design).
mcp
IncludedModel Context Protocol (MCP) server development and tool management. Languages: Python, TypeScript. Capabilities: build MCP servers, integrate external APIs, discover/execute MCP tools, manage multi-server configs, design agent-centric tools. Actions: create, build, integrate, discover, execute, configure MCP servers/tools. Keywords: MCP, Model Context Protocol, MCP server, MCP tool, stdio transport, SSE transport, tool discovery, resource provider, prompt template, external API integration, Gemini CLI MCP, Claude MCP, agent tools, tool execution, server config. Use when: building MCP servers, integrating external APIs as MCP tools, discovering available MCP tools, executing MCP capabilities, configuring multi-server setups, designing tools for AI agents.
react-native-skia
IncludedDesign, build, debug, and optimise high-polish animated graphics in React Native or Expo using @shopify/react-native-skia, Reanimated, and Gesture Handler. Use when the user wants canvas-driven UI, shaders, paths, rich text, image filters, sprite fields, Skottie, video frames, snapshots, web CanvasKit setup, or performance tuning for custom motion-heavy elements such as loaders, hero art, cards, charts, progress indicators, particle systems, or gesture-driven surfaces. Also use when the user asks for fluid, glow, glass, blob, parallax, 60fps/120fps, or GPU-friendly animated effects in React Native, even if they do not explicitly say "Skia". Do not use for ordinary form/layout work with standard views.
plaid
IncludedProduct Led AI Development — guides founders from idea to launched product. Six capabilities: Idea (discover a product idea), Validate (pressure-test the idea against fatal flaws, problem reality, competition, and 2-week MVP feasibility), Plan (vision intake + document generation), Design (translate image references into a design.md spec), Launch (go-to-market strategy), and Build (roadmap execution). Use when someone says "PLAID", "plaid idea", "help me find an idea", "product idea", "idea from my business", "idea from my expertise", "plaid validate", "validate my idea", "pressure-test", "is this idea good", "find fatal flaws", "validate the problem", "plan a product", "define my vision", "generate a PRD", "product strategy", "plaid design", "design from image", "translate image to design", "create design.md", "extract design tokens", "plaid launch", "go-to-market", "launch plan", "GTM strategy", "launch playbook", "plaid build", "build the app", "start building", or "execute the roadmap".
nextjs-framer-motion-animations
IncludedAdds production-safe Motion for React or Framer Motion animations to Next.js apps, including reveal, hover and tap micro-interactions, whileInView, stagger, AnimatePresence, layout and layoutId transitions, reorder, scroll-linked UI, and lightweight route-content transitions. Use when the user asks to add, refactor, or debug Motion or Framer Motion in App Router or Pages Router codebases, especially around server/client boundaries, reduced motion, LazyMotion, bundle size, hydration, or route transitions. Avoid for GSAP-style timelines, WebGL or 3D scenes, heavy scroll storytelling, or CSS-only effects unless Motion is explicitly requested.