mikeparcewski/docs
skills/engineering/docs/SKILL.md
Use when generating documentation from code, auditing documentation coverage for gaps, or detecting code-doc drift after a refactor. Covers generate (API docs, READMEs), audit (coverage metrics, undocumented exports), and sync (stale docs detection) in one skill. NOT for architecture documentation (use the architecture skill) or product requirements (use product/requirements-analysis).
$ install --global
skillsauthnpx skillsauth add mikeparcewski/wicked-garden docsInstall 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: May 7, 2026, 6:26 AM173.1s1 file scanned
SKILL.md
- name:
- docs
- description:
- |
- phase_relevance:
- ["design", "build"]
- archetype_relevance:
- ["*"]
Documentation Engineering Skill
Generate, audit, and sync documentation across the codebase.
Quick Start
Generate docs from code
/wicked-garden:engineering:docs <file-or-component> --type api|readme|guide|inline
Extracts types, signatures, and comments to produce API docs, READMEs, or inline comments.
Audit documentation coverage
/wicked-garden:engineering:docs <path> --audit
Reports coverage (documented vs total exports), quality score, and prioritized gaps.
Detect stale docs after code changes
/wicked-garden:engineering:docs <path> --sync
Identifies documentation that has drifted from implementation after a refactor or rename.
Generate
Transform code into documentation:
- Extract types, method signatures, and inline comments
- Generate API reference (JSDoc / docstring style)
- Create or update README files
- Add inline comments where missing
Output: Markdown docs ready to commit, or inline comment patches.
Audit
Evaluate documentation health across the codebase:
- Find undocumented exported functions, classes, and API endpoints
- Calculate coverage percentage and quality score (description + params + examples)
- Prioritize gaps: High = public APIs, Medium = internal utilities, Low = private/test
Quality Score (0-100):
- Has description: +25
- Has parameters: +25
- Has examples: +30
- Has edge cases: +20
Coverage Report format:
# Documentation Coverage Report
## Summary
| Category | Total | Documented | Coverage |
|-----------|-------|------------|----------|
| Functions | 145 | 98 | 67.6% |
## Top Issues
### Undocumented Public Functions (12)
- `src/api/auth.ts::authenticate` — Core auth
Sync
Detect and fix documentation drift:
- Compare code signatures against existing doc strings
- Flag mismatched parameter names, changed return types, removed methods
- Suggest specific doc updates with before/after diffs
Integration
- Use
wicked-garden:searchto scope the file set before auditing - Native TaskCreate (with
metadata.event_type="task") tracks doc tasks - CI: run audit in
--reportmode to gate PRs that drop below coverage threshold
Best Practices
- Prioritize public APIs first — that is what users see
- Set realistic targets — 80% with good quality beats 100% with stubs
- Run sync after every significant refactor — don't let drift accumulate
- Automate in CI — block PRs that reduce coverage
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