dew-method 0.1.0

package/src/dew-skills/4-implementation/dew-pattern-extraction/steps/step-03-extract-reusable-patterns.md

@@ -0,0 +1,45 @@
+# Step 03 — Extract Reusable Patterns
+
+## Mandatory Rules
+
+- Pattern must include context and trade-offs.
+- Pattern must cite project evidence/artifacts.
+- Do not create universal rule without when-not-to-use.
+
+## Candidate pattern areas
+
+- validation-before-architecture
+- KPI feasibility before modeling
+- source access/sample/schema before P1
+- requirement gate before architecture
+- medallion storage with minimal metadata
+- ingestion schema snapshot + drift detection
+- business rule catalog
+- DQ evidence gate
+- metric serving contract
+- trust limitations statement
+- story evidence manifest
+
+## For each pattern
+
+Record:
+- problem
+- context
+- solution
+- when to use
+- when not to use
+- trade-offs
+- evidence
+- reuse checklist
+
+## Update
+
+Update:
+- reusable-patterns.md
+- pattern-catalog.md
+
+## Continue checkpoint
+
+Ask:
+
+`[C] Continue to extract anti-patterns`

package/src/dew-skills/4-implementation/dew-pattern-extraction/steps/step-04-extract-anti-patterns.md

@@ -0,0 +1,29 @@
+# Step 04 — Extract Anti-Patterns
+
+## Mandatory Rules
+
+- Anti-patterns must describe concrete failure mode.
+- Each anti-pattern needs detection signal and correction path.
+
+## Common DEW anti-patterns
+
+- architecture before source validation
+- KPI without field feasibility
+- source list without access/sample/schema
+- Gold model without grain
+- DQ rule without action/evidence
+- serving metric without trust statement
+- story done without evidence
+- release without E2E validation
+
+## Update
+
+Update:
+- anti-patterns.md
+- reusable-patterns.md
+
+## Continue checkpoint
+
+Ask:
+
+`[C] Continue to pattern review gate`

package/src/dew-skills/4-implementation/dew-pattern-extraction/steps/step-05-pattern-review-gate.md

@@ -0,0 +1,38 @@
+# Step 05 — Pattern Review Gate
+
+## Mandatory Rules
+
+- Stop at this gate.
+- User must approve which patterns become reusable.
+- Weak patterns remain candidate.
+
+## Decision options
+
+A. Approve patterns  
+B. Approve with caveats  
+C. Keep as candidate patterns  
+D. Revise pattern catalog  
+
+## Required table
+
+| Pattern | Status | Evidence | Reuse Risk |
+|---|---|---|---|
+
+## User decision
+
+Ask user to choose A/B/C/D.
+
+Do not continue until user chooses.
+
+## Record
+
+Update:
+- reusable-patterns.md
+- pattern-catalog.md
+- .learning-log.md
+
+## Continue checkpoint
+
+Ask:
+
+`[C] Continue to finalize pattern extraction`

package/src/dew-skills/4-implementation/dew-pattern-extraction/steps/step-06-finalize.md

@@ -0,0 +1,19 @@
+# Step 06 — Finalize Pattern Extraction
+
+## Mandatory Rules
+
+- Do not finalize approved patterns without evidence/context.
+- Run checklist.
+
+## Required outputs
+
+- reusable-patterns.md
+- pattern-catalog.md
+- anti-patterns.md
+- updated learning log
+
+## Next workflow
+
+Recommend:
+
+`dew-skill-qa`

package/src/dew-skills/4-implementation/dew-project-documentation/SKILL.md

@@ -0,0 +1,52 @@
+---
+name: dew-project-documentation
+description: Create user-facing and technical documentation for the released data product from validated artifacts, evidence, and release notes.
+---
+
+# DEW Project Documentation
+
+**Goal:** Create complete project documentation for a released or release-candidate data product.
+
+**Your Role:** You are a data product documentation facilitator.
+
+You summarize validated facts, not assumptions.
+
+## Mandatory Rules
+
+- Do not document a feature as released unless release readiness approved it.
+- Do not hide caveats or limitations.
+- Do not invent source/KPI/model details.
+- User-facing documentation must include trust and limitations.
+- Technical documentation must include run/evidence/DQ/lineage information.
+- If release readiness is missing, trigger `HALT-20 — Release Not Ready`.
+- If evidence is missing, trigger `HALT-18 — No Validation Evidence`.
+
+## Workflow Architecture
+
+This workflow uses step-file architecture.
+
+Rules:
+- Read one step file at a time.
+- Do not skip steps.
+- Stop at Documentation Review Gate.
+- Preserve release caveats.
+- Update frontmatter after each completed step.
+
+## On Activation
+
+1. Resolve customization.
+2. Load persistent facts.
+3. Load config if present.
+4. Load:
+   - `{workflow.project_documentation_template}`
+   - `{workflow.data_product_readme_template}`
+   - `{workflow.data_dictionary_template}`
+   - `{workflow.runbook_summary_template}`
+   - `{workflow.documentation_quality_rubric}`
+5. Greet user in configured language.
+
+## Execution
+
+Read fully and follow:
+
+`steps/step-01-init.md`

package/src/dew-skills/4-implementation/dew-project-documentation/assets/data-dictionary-template.md

@@ -0,0 +1,27 @@
+# Data Dictionary Template
+
+```markdown
+# Data Dictionary
+
+## Dataset Summary
+
+| Dataset | Layer | Grain | Description |
+|---|---|---|---|
+
+## Dataset: {dataset_name}
+
+### Layer
+
+### Grain
+
+One row represents:
+
+### Fields
+
+| Field | Type | Description | Source / Rule | Required? | DQ Rule |
+|---|---|---|---|---|---|
+
+### Keys
+
+### Caveats
+```

package/src/dew-skills/4-implementation/dew-project-documentation/assets/data-product-readme-template.md

@@ -0,0 +1,37 @@
+# Data Product README Template
+
+```markdown
+# {Project Name}
+
+## What this data product does
+
+## Who should use it
+
+## What decisions it supports
+
+## Quick Start
+
+```bash
+# setup / run command
+```
+
+## Data Sources
+
+## Outputs
+
+## Metrics
+
+## Freshness
+
+## Trust Level
+
+## Known Limitations
+
+## Evidence
+
+## Project Structure
+
+## Runbook
+
+## Contact / Owner
+```

package/src/dew-skills/4-implementation/dew-project-documentation/assets/documentation-quality-rubric.md

@@ -0,0 +1,25 @@
+# Documentation Quality Rubric
+
+## Good documentation
+
+- states what the product does
+- states who should use it
+- states what not to use it for
+- includes data sources
+- includes KPI formulas and grain
+- includes data dictionary
+- includes freshness
+- includes trust and limitations
+- includes run instructions
+- links to evidence
+- preserves caveats
+
+## Bad documentation
+
+- hides caveats
+- says “data is clean” without DQ evidence
+- lists KPIs without formulas
+- lists tables without grain
+- lacks run instructions
+- lacks trust statement
+- treats release-candidate as production

package/src/dew-skills/4-implementation/dew-project-documentation/assets/project-documentation-template.md

@@ -0,0 +1,81 @@
+# Project Documentation Template
+
+```markdown
+---
+title: "{Project Name} Project Documentation"
+status: draft
+created: {YYYY-MM-DD}
+updated: {YYYY-MM-DD}
+workflow: dew
+phase: "4-implementation"
+stepsCompleted: []
+decisionGates:
+  GATE-28-documentation-quality:
+    status: pending
+evidence: []
+assumptions: []
+caveats: []
+---
+
+# {Project Name} Documentation
+
+## 0. Purpose
+
+This documentation explains the released or release-candidate data product.
+
+## 1. Product Summary
+
+### Product Name
+
+### Product Type
+
+### Release Type
+
+### Intended Users
+
+### Decisions Supported
+
+## 2. What Is Included
+
+## 3. What Is Not Included
+
+## 4. Data Sources
+
+| Source ID | Source Name | Role | Validation Status | Caveat |
+|---|---|---|---|---|
+
+## 5. Data Flow Summary
+
+Source → Bronze → Silver → Gold → Serving
+
+## 6. Metrics / KPIs
+
+| KPI ID | Name | Formula | Grain | Serving Asset | Caveat |
+|---|---|---|---|---|---|
+
+## 7. Data Models
+
+| Model | Layer | Grain | Purpose | Consumer |
+|---|---|---|---|---|
+
+## 8. Data Quality
+
+| DQ Rule | Dataset | Severity | Action | Evidence |
+|---|---|---|---|---|
+
+## 9. Trust and Limitations
+
+## 10. Freshness
+
+## 11. Access / Governance
+
+## 12. How to Run
+
+## 13. Evidence Summary
+
+## 14. Operational Notes
+
+## 15. Known Issues / Caveats
+
+## 16. Next Steps
+```

package/src/dew-skills/4-implementation/dew-project-documentation/assets/runbook-summary-template.md

@@ -0,0 +1,26 @@
+# Runbook Summary Template
+
+```markdown
+# Runbook Summary
+
+## Operational Mode
+
+## Run Schedule
+
+## How to Run
+
+## Expected Outputs
+
+## Monitoring
+
+## Common Failures
+
+| Failure | Detection | Action |
+|---|---|---|
+
+## Backfill / Replay
+
+## Evidence Produced
+
+## Incident Notes
+```

package/src/dew-skills/4-implementation/dew-project-documentation/checklist.md

@@ -0,0 +1,16 @@
+# Project Documentation Checklist
+
+- [ ] Release readiness report loaded.
+- [ ] Release notes loaded.
+- [ ] Serving spec loaded.
+- [ ] Metric contract loaded.
+- [ ] Trust limitations loaded.
+- [ ] Data model spec loaded.
+- [ ] DQ rules loaded.
+- [ ] DataOps runbook loaded.
+- [ ] Project documentation created.
+- [ ] Data product README created.
+- [ ] Data dictionary created.
+- [ ] Runbook summary created.
+- [ ] Caveats preserved.
+- [ ] Documentation review gate completed.

package/src/dew-skills/4-implementation/dew-project-documentation/customize.toml

@@ -0,0 +1,43 @@
+# DO NOT EDIT -- overwritten on every update.
+#
+# Workflow customization surface for dew-project-documentation.
+
+[workflow]
+
+activation_steps_prepend = []
+activation_steps_append = []
+
+persistent_facts = [
+  "file:{project-root}/**/release-readiness-report.md",
+  "file:{project-root}/**/release-notes.md",
+  "file:{project-root}/**/release-checklist.md",
+  "file:{project-root}/**/e2e-validation-report.md",
+  "file:{project-root}/**/final-evidence-review.md",
+  "file:{project-root}/**/serving-data-product-spec.md",
+  "file:{project-root}/**/metric-serving-contract.md",
+  "file:{project-root}/**/trust-and-limitations-statement.md",
+  "file:{project-root}/**/data-model-spec.md",
+  "file:{project-root}/**/data-quality-rules.md",
+  "file:{project-root}/**/governance-security-review.md",
+  "file:{project-root}/**/dataops-runbook.md",
+  "file:{project-root}/**/observability-plan.md",
+  "file:{project-root}/**/validation-evidence-index.md",
+  "file:{project-root}/**/.decision-log.md",
+  "file:{project-root}/**/.learning-log.md",
+]
+
+on_complete = ""
+
+project_documentation_template = "assets/project-documentation-template.md"
+data_product_readme_template = "assets/data-product-readme-template.md"
+data_dictionary_template = "assets/data-dictionary-template.md"
+runbook_summary_template = "assets/runbook-summary-template.md"
+documentation_quality_rubric = "assets/documentation-quality-rubric.md"
+checklist = "checklist.md"
+
+documentation_output_path = "{implementation_artifacts}/documentation"
+run_folder_pattern = "documentation-{project_name}-{date}"
+
+decision_log_path = "{planning_artifacts}/.decision-log.md"
+learning_log_path = "{learning_artifacts}/.learning-log.md"
+evidence_index_path = "{evidence_artifacts}/validation-evidence-index.md"

package/src/dew-skills/4-implementation/dew-project-documentation/steps/step-01-init.md

@@ -0,0 +1,42 @@
+# Step 01 — Project Documentation Initialization
+
+## Mandatory Rules
+
+- Do not create release documentation before release readiness exists.
+- Do not approve documentation in this step.
+
+## Task
+
+Initialize documentation workflow.
+
+## Sequence
+
+1. Detect existing documentation workflow.
+
+Look for:
+- `{workflow.documentation_output_path}/**/project-documentation.md`
+- `{implementation_artifacts}/**/*documentation*.md`
+- `{implementation_artifacts}/**/README*.md`
+
+2. Validate prerequisite:
+- `release-readiness-report.md`
+
+If missing:
+- return to `dew-release-readiness`
+- or trigger `HALT-20 — Release Not Ready`
+
+3. Create workspace:
+
+`{workflow.documentation_output_path}/{workflow.run_folder_pattern}/`
+
+Create:
+- `project-documentation.md`
+- `data-product-readme.md`
+- `data-dictionary.md`
+- `runbook-summary.md`
+
+4. Initialize frontmatter.
+
+5. Continue checkpoint:
+
+`[C] Continue to load release context`

package/src/dew-skills/4-implementation/dew-project-documentation/steps/step-02-load-release-context.md

@@ -0,0 +1,54 @@
+# Step 02 — Load Release Context
+
+## Mandatory Rules
+
+- Load release, serving, model, DQ, governance, and DataOps context.
+- Do not invent documentation content.
+
+## Task
+
+Extract documentation context.
+
+## Extract
+
+From release:
+- release type
+- included scope
+- excluded scope
+- caveats
+- risks
+
+From serving:
+- users
+- outputs
+- metrics
+- freshness
+- trust limitations
+
+From model:
+- datasets
+- fields
+- grain
+- KPI mapping
+
+From DQ:
+- rules
+- severity
+- actions
+- evidence
+
+From DataOps:
+- run schedule
+- monitoring
+- run commands
+- incident/backfill notes
+
+## Update
+
+Update all documentation files.
+
+## Continue checkpoint
+
+Ask:
+
+`[C] Continue to create user-facing docs`

package/src/dew-skills/4-implementation/dew-project-documentation/steps/step-03-create-user-facing-docs.md

@@ -0,0 +1,33 @@
+# Step 03 — Create User-Facing Docs
+
+## Mandatory Rules
+
+- User-facing docs must include limitations.
+- Do not expose technical noise unless useful.
+- Do not overstate trust.
+
+## Task
+
+Create user-facing documentation.
+
+## Include
+
+- what product does
+- who should use it
+- what decisions it supports
+- metrics
+- freshness
+- limitations
+- how to interpret outputs
+- issue reporting
+
+## Update
+
+- data-product-readme.md
+- project-documentation.md
+
+## Continue checkpoint
+
+Ask:
+
+`[C] Continue to create technical docs`

package/src/dew-skills/4-implementation/dew-project-documentation/steps/step-04-create-technical-docs.md

@@ -0,0 +1,37 @@
+# Step 04 — Create Technical Docs
+
+## Mandatory Rules
+
+- Technical docs must include data dictionary, runbook, evidence, and DQ.
+- Models must include grain.
+- Metrics must include formulas.
+
+## Task
+
+Create technical documentation.
+
+## Include
+
+- data flow
+- datasets
+- fields
+- keys
+- grain
+- source mapping
+- DQ rules
+- evidence paths
+- run commands
+- operational notes
+- governance/access notes
+
+## Update
+
+- project-documentation.md
+- data-dictionary.md
+- runbook-summary.md
+
+## Continue checkpoint
+
+Ask:
+
+`[C] Continue to documentation review gate`

package/src/dew-skills/4-implementation/dew-project-documentation/steps/step-05-documentation-review-gate.md

@@ -0,0 +1,45 @@
+# Step 05 — Documentation Review Gate
+
+## Mandatory Rules
+
+- Stop at this gate.
+- User must approve documentation quality.
+- Missing trust/limitations blocks approval for user-facing docs.
+
+## Decision options
+
+A. Documentation approved  
+B. Approved with caveats  
+C. Needs revision  
+D. Block documentation  
+
+## Required review
+
+| Area | Status | Finding |
+|---|---|---|
+| User-facing clarity | | |
+| Technical completeness | | |
+| KPI formulas | | |
+| Grain | | |
+| DQ evidence | | |
+| Trust limitations | | |
+| Run instructions | | |
+
+## User decision
+
+Ask user to choose A/B/C/D.
+
+Do not continue until user chooses.
+
+## Record
+
+Update:
+- project-documentation.md
+- .decision-log.md
+- .learning-log.md if enabled
+
+## Continue checkpoint
+
+Ask:
+
+`[C] Continue to finalize documentation`

package/src/dew-skills/4-implementation/dew-project-documentation/steps/step-06-finalize.md

@@ -0,0 +1,20 @@
+# Step 06 — Finalize Documentation
+
+## Mandatory Rules
+
+- Do not finalize if documentation gate is blocked.
+- Run checklist.
+- Preserve caveats.
+
+## Required outputs
+
+- project-documentation.md
+- data-product-readme.md
+- data-dictionary.md
+- runbook-summary.md
+
+## Next workflow
+
+Recommend:
+
+`dew-learning-capture`