mikeparcewski/wicked-garden-engineering-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 wicked-garden-engineering-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: Jul 12, 2026, 7:06 AM19.7s1 file scanned
SKILL.md
- name:
- wicked-garden-engineering-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 (the docs action of the engineering domain skill routes here).
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/wicked-garden-engineering-conformance-reviewer
development
VerifiedTrustedCommunity
Pattern-conformance agent-half: evaluates a produced artifact or diff against a set of architectural/design pattern rules from the conformance-rule store (wicked_governance schema). Returns structured findings with rule ID, severity, and rationale — the deterministic half (mechanical rule recall) is done by the guard pipeline; this is the semantic evaluation step. Triggered by: the guard_pipeline `outgov_pattern` check (session-close), or explicitly by an engineering review when WICKED_OUTGOV_RULES_DIR is populated. NOT a replacement for the full `engineering` review skill — focuses only on conformance to stored Pattern rules; architecture and code-quality checks live in the `engineering` skill. Semantic evaluation reuses `wicked-garden-qe-semantic-reviewer` as the designated agent-half evaluator (per garden#983 spec). This skill is the orchestrating wrapper that loads applicable Pattern rules and delegates the per-rule semantic judgment to qe-semantic-reviewer.
8SKILL.mdUpdated Jul 22, 2026
mikeparcewski/wicked-garden-domain
tools
VerifiedTrustedCommunity
The FOUNDATIONAL domain-model capability: extract a codebase's domain — testable business rules (with confidence + provenance), entities, requirements — as a schema-conformant model on the estate graph. The workers annotate the store; wicked-core reads it and builds the requirements graph, coverage-gating fail-closed. Steers three fork workers. A shared substrate, not a modernization tool. The `modernize` archetype DERIVES from it; build / migrate / review / specify / explore consume the SAME domain model — none OWN it. Understanding a codebase's domain is upstream of almost everything else garden does. Use when: "extract the business rules / domain model from this codebase", "build a requirements graph from the code", "what does this system actually require", "reverse-engineer the domain before we build/port/migrate". Works on ANY codebase (modern or legacy) — the value is the domain model, not the porting. NOT the code transform itself (that is the archetype consuming this model). This skill produces the DOMAIN MODEL, not new code.
8SKILL.mdUpdated Jul 15, 2026
mikeparcewski/wicked-garden-domain-modeler
development
VerifiedTrustedCommunity
Domain-graph fork worker for the modernize archetype. Groups the estate's Louvain communities into business domains, attaches each requirement to its cluster (advisory cluster_id provenance), and invokes wicked-core's domain-graph build (which reads the annotated estate store, recomputes coverage fail-closed, and builds the requirements graph) — then validates core's output against the vendored schema. Use when: dispatched by wicked-garden-domain after rule extraction to turn a flat rule set into cluster-keyed domains; "group these into domains", "build the requirements graph", "translate clusters into a domain model". NOT for mining the rules themselves (that is domain-extractor) or threat-modeling (that is domain-coverage).
8SKILL.mdUpdated Jul 15, 2026
mikeparcewski/wicked-garden-domain-extractor
tools
VerifiedTrustedCommunity
Rule-extraction fork worker for the FOUNDATIONAL domain-model capability. Mines testable business rules from a codebase — each with a numeric confidence and a provenance{source, ref, source_kinds} — and annotates them into the estate store so wicked-core can build the domain-model requirements graph (coverage-gated). This is a substrate, not a modernization tool: the `modernize` archetype DERIVES from it, and build / migrate / review / specify / explore can consume the same domain model — none OWN it. Use when: dispatched by wicked-garden-domain to mine the business_rules of a codebase (or a module); "extract the domain rules", "what does this system require", building the requirements half of a domain model. NOT for grouping into domains (that is domain-modeler) or judging coverage (that is domain-coverage — a seat-distinct evaluator).
8SKILL.mdUpdated Jul 15, 2026