mikeparcewski/generate
skills/engineering/generate/SKILL.md
Generate documentation from code - extract types, comments, and signatures to create API docs, README files, and reference documentation. Focus on useful, actionable docs. Use when: "generate docs", "create documentation", "document the API", "generate README", "make docs from code"
$ install --global
skillsauthnpx skillsauth add mikeparcewski/wicked-garden generateInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 16, 2026, 5:58 AM4.4s3 files scanned
SKILL.md
- name:
- generate
- description:
- |
- Use when:
- generate docs", "create documentation", "document the API",
Generate Documentation Skill
Create useful documentation from code - extract information and present it clearly.
Purpose
Transform code into documentation:
- Extract types, signatures, and comments
- Generate API documentation
- Create/update README files
- Discover and use documentation tools
Commands
| Command | Purpose |
|---------|---------|
| /wicked-garden:engineering:generate [path] | Generate docs from code |
| /wicked-garden:engineering:generate --api | Generate API documentation |
| /wicked-garden:engineering:generate --readme | Generate/update README |
| /wicked-garden:engineering:generate --types | Generate type documentation |
Quick Start
# Generate general documentation
/wicked-garden:engineering:generate src/
# Generate API documentation
/wicked-garden:engineering:generate src/api --api
# Update README
/wicked-garden:engineering:generate --readme
Process
1. Analyze Target
Understand what to document:
- Language and framework
- Code structure (functions, classes, modules)
- Existing comments and docstrings
- Type information
2. Discover Tools
Check for documentation tooling:
- JavaScript/TypeScript: TypeDoc, JSDoc, Docusaurus
- Python: Sphinx, MkDocs, pdoc
- Rust: rustdoc, Go: godoc
If tools exist, use them. Otherwise extract manually.
3. Extract Information
From code, extract:
- Function signatures and descriptions
- Class structure and methods
- API endpoints and schemas
- Type definitions
4. Generate Documentation
Create focused, useful docs:
- README: overview, installation, quick start
- API docs: endpoints, parameters, responses
- Reference: functions, classes, types
See Templates: API and Templates: Module for standard formats.
Language Patterns
Extract from:
- JavaScript/TypeScript: JSDoc comments and type definitions
- Python: Docstrings and type hints
- REST APIs: Route definitions and schemas
- Other: Language-specific doc comments
Tool Integration
Check for existing doc tools (TypeDoc, Sphinx, rustdoc) and use them. If none exist, extract and generate manually.
Read project metadata from package.json or pyproject.toml for README generation.
Best Practices
- Include Examples - Every function/endpoint needs an example
- Use Type Information - Show parameter types clearly
- Document Edge Cases - Note unusual behavior
- Don't Generate Boilerplate - Focus on useful content
- Update, Don't Replace - Preserve manual sections
Integration
Use wicked-garden:search to find code to document. Use wicked-garden:mem to learn and maintain project doc style.
Events
[docs:generated:success]- Documentation created[docs:readme:updated:success]- README updated[docs:api:generated:success]- API docs generated
Tips
- Use Existing Tools - Don't reinvent TypeDoc/Sphinx
- Parse, Don't Guess - Read actual code structure
- Include Examples - Show real usage
- Extract from Tests - Tests are usage examples
- Link Related Docs - Cross-reference related APIs
- Update, Don't Replace - Preserve manual sections
Reference
- Templates: API - README, function, API, class, type templates
- Templates: Module - OpenAPI, error, config templates and usage
Related Skills
mikeparcewski/skills/engineering/large-scale-migration
development
VerifiedTrustedCommunity
--- name: large-scale-migration description: How to execute a LARGE MECHANICAL change across any codebase with LEVERAGE instead of an agent-grind or hand-edits — a cross-cutting migration, refactor, rename, dialect/framework/DB port, library adoption, or bulk transform. The map→transform→gate pattern: a deterministic transform driven by a source-of-truth map, proven by a differential-equivalence gate. Use when the work is "migrate all X to Y", "rename Z everywhere", "port to a new DB/dialect/fra
8SKILL.mdUpdated Jun 3, 2026
mikeparcewski/wicked-garden:classify
testing
VerifiedTrustedCommunity
v11 LLM-based work-shape classifier. Replaces the regex archetype detector with the model's own reasoning. Reads the user's prompt, picks the right archetype(s) from the catalog, identifies signals (blast_radius, novelty, reversibility, etc.), and persists to SessionState so subsequent turns steer correctly. Use when: the prompt_submit hook emitted a `<wg classify-due />` directive, OR explicitly invoked at session start, OR when re-classifying after the user changes scope mid-session.
8SKILL.mdUpdated May 26, 2026
mikeparcewski/wicked-garden:archetype
tools
VerifiedTrustedCommunity
v11 work-shape archetype runner. When a prompt has been routed to one of the 9 archetypes (triage, explore, specify, decide, ship, review, incident, build, migrate), this skill is the entry point. It picks the right per-archetype playbook from refs/ and executes the phase shape declared in `.claude-plugin/archetypes.json`. Use when: a `<wg archetype="X">` or `<wg archetypes>` system-reminder tag appears, an explicit "let's run the X archetype" request, or when one of the per-archetype slash commands resolves to this skill.
8SKILL.mdUpdated May 8, 2026
mikeparcewski/intent
development
VerifiedTrustedCommunity
Show or set the session intent variable. Intent gates how loud the framework is — simple-edit (silent), feature/research (synthesis directive), rigor (full crew context). Auto-detected on turn 1; this skill overrides explicitly. Sticky for the session. Use when: "set intent", "intent override", "/wicked-garden:intent", "make the framework quiet", "force rigor", "what's my intent".
8SKILL.mdUpdated May 6, 2026