mikeparcewski/sync
skills/engineering/sync/SKILL.md
Keep documentation in sync with code changes. Detect stale docs, identify drift between code and docs, and suggest updates when code changes. Use when: "check doc freshness", "sync docs", "docs out of date", "update docs after refactor", "docs drift", "docs out of sync"
$ install --global
skillsauthnpx skillsauth add mikeparcewski/wicked-garden syncInstall 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 19, 2026, 4:07 AM4.5s1 file scanned
SKILL.md
- name:
- sync
- description:
- |
- Use when:
- check doc freshness", "sync docs", "docs out of date",
Sync Documentation Skill
Keep documentation fresh by detecting when code changes have made docs stale.
Purpose
Maintain documentation accuracy:
- Detect code changes that affect docs
- Identify stale documentation
- Suggest specific updates
- Track documentation freshness
- Prevent documentation drift
Commands
| Command | Purpose |
|---------|---------|
| /wicked-garden:engineering:sync | Check all documentation freshness |
| /wicked-garden:engineering:sync [path] | Check specific path |
| /wicked-garden:engineering:sync --fix | Auto-update where possible |
Quick Start
# Check all documentation
/wicked-garden:engineering:sync
# Check specific directory
/wicked-garden:engineering:sync src/api
# Auto-fix simple issues
/wicked-garden:engineering:sync --fix
Detection Strategies
Compare file timestamps (code modified after docs = STALE). Compare function signatures (code vs docs = DRIFT). Validate API specs against code (path/method mismatches = DRIFT).
Issue Categories
STALE - Documentation older than code:
- Docs not updated after code changes
- File modification time comparison
- Risk: Medium
DRIFT - Documentation doesn't match code:
- Function signatures changed
- Parameters added/removed
- Types modified
- Risk: High
MISSING - Documentation incomplete:
- New code not documented
- New parameters not described
- Risk: Medium
OUTDATED - Referenced deprecated code:
- Docs reference removed functions
- Examples use old API
- Risk: Low
Sync Report Format
# Documentation Sync Report
## Summary
- Issues found: 7
- STALE: 3
- DRIFT: 2
- MISSING: 2
## Issues
### DRIFT: docs/api/users.md
**Issue:** Function signature changed
**Code:**
```typescript
function createUser(data: UserInput, options?: CreateOptions)
Docs:
### createUser(data: UserInput)
Suggestion:
Add documentation for options parameter
Priority: HIGH
## Auto-Fix Capabilities
Can auto-fix simple type changes, timestamps, and link updates.
Cannot auto-fix parameter descriptions, behavior changes, or examples (requires human review).
## Integration
Use **wicked-garden:search** to find docs. **wicked-crew** auto-checks after build.
Native TaskCreate (with `metadata.event_type="task"`) tracks doc updates. Git hooks check on commit.
## Events
- `[docs:stale:warning]` - Stale documentation found
- `[docs:drift:warning]` - Documentation drift detected
- `[docs:missing:warning]` - Missing documentation found
- `[docs:synced:success]` - Documentation synchronized
## Configuration
```yaml
sync:
max_staleness_days: 30 # Warn if docs unchanged for 30 days
check_signatures: true # Compare function signatures
check_types: true # Compare type definitions
check_openapi: true # Validate OpenAPI against code
auto_fix: false # Auto-fix simple issues
Best Practices
- Run Regularly - Check sync after major changes
- Prioritize High Impact - Fix signature mismatches first
- Track Over Time - Monitor documentation health
- Automate Checks - Use git hooks or CI
- Review Auto-Fixes - Don't blindly apply changes
Tips
- Compare Timestamps - Quick first check
- Parse Code - Extract actual signatures
- Validate Specs - Check OpenAPI against routes
- Check Examples - Ensure examples still work
- Link Issues - Connect doc issues to code changes
- Make It Actionable - Specific suggestions, not just warnings
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