ace-docs 0.31.8 → 0.34.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +38 -0
- data/README.md +23 -0
- data/handbook/workflow-instructions/docs/update-roadmap.wf.md +20 -20
- data/handbook/workflow-instructions/docs/update-usage.wf.md +9 -9
- data/lib/ace/docs/cli/commands/analyze.rb +3 -2
- data/lib/ace/docs/cli/commands/analyze_consistency.rb +3 -2
- data/lib/ace/docs/organisms/cross_document_analyzer.rb +3 -1
- data/lib/ace/docs/organisms/document_registry.rb +1 -1
- data/lib/ace/docs/version.rb +1 -1
- metadata +2 -3
- data/handbook/workflow-instructions/docs/create-cookbook.wf.md +0 -434
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: ce697d65c80ba44319cf2484f1a5568981b81e5c205a8397bbf33b0dbd69b22d
|
|
4
|
+
data.tar.gz: 8b2846bcff7af3e21e5411fa2e3e3babd06b9dc5718075e2c046adac082d29dc
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 3354a595ec9ab354ac641ab07ae5568dde41e938feda0a5f734b41015a001a069e6c5cdb6de4ee89c3a714189b4afbec99e72582bc8eb14f148df5d73645f7bd
|
|
7
|
+
data.tar.gz: 9c56bd30cc6bd9392461d3cb28669aac49b2d37e4c9e22de61f5d051b93de6da0aa823a8b3d6422dbe5a153aff79d148bfa4e07c4fa06b910ed3092ee88e8469
|
data/CHANGELOG.md
CHANGED
|
@@ -6,6 +6,44 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
|
+
## [0.34.1] - 2026-04-16
|
|
10
|
+
|
|
11
|
+
### Fixed
|
|
12
|
+
- Made `analyze-consistency` fail closed when no report file is produced and aligned E2E verification with explicit provider-unavailable evidence.
|
|
13
|
+
|
|
14
|
+
## [0.34.0] - 2026-04-14
|
|
15
|
+
|
|
16
|
+
### Added
|
|
17
|
+
- Added a new goal-style `TS-DOCS-002-analysis-workflows` E2E scenario covering `ace-docs analyze` and `ace-docs analyze-consistency` command journeys with impact-first verification guidance.
|
|
18
|
+
|
|
19
|
+
### Changed
|
|
20
|
+
- Hardened `TS-DOCS-001` verifier expectations for discover/validate/status to prioritize seeded state and stable outcome semantics over brittle phrasing checks.
|
|
21
|
+
- Expanded usage guidance for `analyze` and `analyze-consistency` with deterministic artifact/report location notes for reproducible CLI workflows.
|
|
22
|
+
- Updated `analyze` and `analyze-consistency` command help text to document output/report artifact locations and accurate exit-code behavior.
|
|
23
|
+
|
|
24
|
+
## [0.33.1] - 2026-04-13
|
|
25
|
+
|
|
26
|
+
### Changed
|
|
27
|
+
- Completed the batch i05 migration follow-through for this package and aligned it with the restarted `fast` / `feat` / `e2e` verification model.
|
|
28
|
+
|
|
29
|
+
### Technical
|
|
30
|
+
- Included in the coordinated assignment-driven patch release for batch i05 package updates.
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
## [0.33.0] - 2026-04-12
|
|
34
|
+
|
|
35
|
+
### Changed
|
|
36
|
+
- Migrated `ace-docs` to the `fast` / `feat` / `e2e` testing model by moving deterministic coverage from legacy test paths into `test/fast` and `test/feat`, and aligning TS-DOCS-001 scenario metadata and runner/verifier assets with the new artifact contract.
|
|
37
|
+
|
|
38
|
+
## [0.32.1] - 2026-04-10
|
|
39
|
+
|
|
40
|
+
### Fixed
|
|
41
|
+
- Restored docs-management ignore coverage for legacy `test/e2e/**/*.md` scenario markdown paths during the E2E path migration.
|
|
42
|
+
|
|
43
|
+
## [0.32.0] - 2026-04-01
|
|
44
|
+
|
|
45
|
+
### Changed
|
|
46
|
+
- Removed active cookbook workflow ownership from `ace-docs` by deleting `create-cookbook.wf.md` and updating handbook catalog references.
|
|
9
47
|
|
|
10
48
|
## [0.31.8] - 2026-03-31
|
|
11
49
|
|
data/README.md
CHANGED
|
@@ -36,5 +36,28 @@
|
|
|
36
36
|
|
|
37
37
|
**Enforce docs quality in release loops** - pair with [ace-lint](../ace-lint) for markdown checks and use `ace-docs` update workflows to keep guides, READMEs, and references in sync.
|
|
38
38
|
|
|
39
|
+
For concrete analyze/update entry points and deterministic CLI examples, see the [Usage Guide](docs/usage.md#analyze) and the [analyze-and-update workflow examples](docs/usage.md#analyze-and-update-workflow).
|
|
40
|
+
|
|
41
|
+
## Testing Contract
|
|
42
|
+
|
|
43
|
+
Run deterministic package coverage with:
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
ace-test ace-docs
|
|
47
|
+
ace-test ace-docs all
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Run deterministic feature coverage:
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
ace-test ace-docs feat
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Run retained workflow scenarios in E2E:
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
ace-test-e2e ace-docs
|
|
60
|
+
```
|
|
61
|
+
|
|
39
62
|
---
|
|
40
63
|
[Getting Started](docs/getting-started.md) | [Usage Guide](docs/usage.md) | [Handbook - Skills, Agents, Templates](docs/handbook.md) | Part of [ACE](https://github.com/cs3b/ace)
|
|
@@ -11,13 +11,13 @@ ace-docs:
|
|
|
11
11
|
|
|
12
12
|
## Goal
|
|
13
13
|
|
|
14
|
-
Synchronize the project roadmap (`.ace-
|
|
14
|
+
Synchronize the project roadmap (`.ace-task/roadmap.md`) with the current state of releases and tasks in the `.ace-task/` directory structure. This workflow analyzes release folders, updates the Planned Major Releases table, synchronizes cross-release dependencies, and maintains roadmap format compliance per the Roadmap Definition Guide.
|
|
15
15
|
|
|
16
16
|
## Prerequisites
|
|
17
17
|
|
|
18
|
-
* `.ace-
|
|
19
|
-
* `.ace-
|
|
20
|
-
* `ace-
|
|
18
|
+
* `.ace-task/roadmap.md` exists and follows roadmap-definition.g.md structure
|
|
19
|
+
* `.ace-task/` directory contains release folders with release.md files
|
|
20
|
+
* `ace-task` CLI tool available for release queries
|
|
21
21
|
* `ace-nav` available for workflow protocol support
|
|
22
22
|
* Git repository in clean state for committing changes
|
|
23
23
|
|
|
@@ -33,7 +33,7 @@ Synchronize the project roadmap (`.ace-taskflow/roadmap.md`) with the current st
|
|
|
33
33
|
|
|
34
34
|
```bash
|
|
35
35
|
# Get roadmap path
|
|
36
|
-
cat .ace-
|
|
36
|
+
cat .ace-task/roadmap.md
|
|
37
37
|
```
|
|
38
38
|
|
|
39
39
|
**Capture current state:**
|
|
@@ -73,14 +73,14 @@ cat .ace-taskflow/roadmap.md
|
|
|
73
73
|
|
|
74
74
|
### 3. Analyze Release State
|
|
75
75
|
|
|
76
|
-
**Discover all releases in .ace-
|
|
76
|
+
**Discover all releases in .ace-task structure:**
|
|
77
77
|
|
|
78
78
|
```bash
|
|
79
79
|
# Get current release
|
|
80
80
|
ace-release
|
|
81
81
|
|
|
82
82
|
# List all release directories
|
|
83
|
-
ls -d .ace-
|
|
83
|
+
ls -d .ace-task/v.*/ 2>/dev/null || echo "No releases found"
|
|
84
84
|
```
|
|
85
85
|
|
|
86
86
|
**For each release found, extract:**
|
|
@@ -101,17 +101,17 @@ ls -d .ace-taskflow/v.*/ 2>/dev/null || echo "No releases found"
|
|
|
101
101
|
**Synchronization Rules:**
|
|
102
102
|
|
|
103
103
|
1. **Add New Releases:**
|
|
104
|
-
- If release exists in `.ace-
|
|
104
|
+
- If release exists in `.ace-task/` but NOT in roadmap table
|
|
105
105
|
- Extract release information from release.md
|
|
106
106
|
- Add row to Planned Major Releases table with proper format
|
|
107
107
|
|
|
108
108
|
2. **Update Existing Releases:**
|
|
109
|
-
- If release exists in both roadmap and `.ace-
|
|
109
|
+
- If release exists in both roadmap and `.ace-task/`
|
|
110
110
|
- Compare current information with release.md
|
|
111
111
|
- Update any changed fields (goals, target window, epics)
|
|
112
112
|
|
|
113
113
|
3. **Remove Completed Releases:**
|
|
114
|
-
- If release is marked done/completed in `.ace-
|
|
114
|
+
- If release is marked done/completed in `.ace-task/`
|
|
115
115
|
- Remove entire row from Planned Major Releases table
|
|
116
116
|
- Ensure release information captured in changelog
|
|
117
117
|
- Document removal in Update History
|
|
@@ -140,7 +140,7 @@ ls -d .ace-taskflow/v.*/ 2>/dev/null || echo "No releases found"
|
|
|
140
140
|
- Remove or update obsolete statements
|
|
141
141
|
|
|
142
142
|
2. **Add new dependencies:**
|
|
143
|
-
- Analyze task dependencies from `.ace-
|
|
143
|
+
- Analyze task dependencies from `.ace-task/` structure
|
|
144
144
|
- Identify cross-release blocking dependencies
|
|
145
145
|
- Add clear dependency statements to Section 5
|
|
146
146
|
|
|
@@ -199,7 +199,7 @@ Add new row to Update History table (Section 6) at the TOP:
|
|
|
199
199
|
- Version numbers use semantic versioning
|
|
200
200
|
|
|
201
201
|
3. **Consistency Check:**
|
|
202
|
-
- Releases in table match `.ace-
|
|
202
|
+
- Releases in table match `.ace-task/` structure
|
|
203
203
|
- Dependencies reference valid releases/epics
|
|
204
204
|
- Update history reflects changes made
|
|
205
205
|
|
|
@@ -214,10 +214,10 @@ Add new row to Update History table (Section 6) at the TOP:
|
|
|
214
214
|
|
|
215
215
|
```bash
|
|
216
216
|
# Review changes before committing
|
|
217
|
-
git diff .ace-
|
|
217
|
+
git diff .ace-task/roadmap.md
|
|
218
218
|
|
|
219
219
|
# Stage roadmap file
|
|
220
|
-
git add .ace-
|
|
220
|
+
git add .ace-task/roadmap.md
|
|
221
221
|
|
|
222
222
|
# Commit with descriptive message
|
|
223
223
|
git commit -m "docs(roadmap): update planned releases and synchronize with current state"
|
|
@@ -229,7 +229,7 @@ git commit -m "docs(roadmap): update planned releases and synchronize with curre
|
|
|
229
229
|
- Examples:
|
|
230
230
|
- `docs(roadmap): add v.0.9.0 Mono-Repo to planned releases`
|
|
231
231
|
- `docs(roadmap): remove completed v.0.8.0 from planned releases`
|
|
232
|
-
- `docs(roadmap): synchronize release status with .ace-
|
|
232
|
+
- `docs(roadmap): synchronize release status with .ace-task structure`
|
|
233
233
|
|
|
234
234
|
## Error Handling
|
|
235
235
|
|
|
@@ -254,8 +254,8 @@ git commit -m "docs(roadmap): update planned releases and synchronize with curre
|
|
|
254
254
|
- Inconsistent release naming
|
|
255
255
|
|
|
256
256
|
**Recovery Steps:**
|
|
257
|
-
1. Report discrepancies between `.ace-
|
|
258
|
-
2. Determine authoritative source (usually `.ace-
|
|
257
|
+
1. Report discrepancies between `.ace-task/` and roadmap
|
|
258
|
+
2. Determine authoritative source (usually `.ace-task/` structure)
|
|
259
259
|
3. Update roadmap to match actual release state
|
|
260
260
|
4. Document assumptions in Update History
|
|
261
261
|
|
|
@@ -328,7 +328,7 @@ git commit -m "docs(roadmap): update planned releases and synchronize with curre
|
|
|
328
328
|
## Success Criteria
|
|
329
329
|
|
|
330
330
|
- [ ] Roadmap format validated against roadmap-definition.g.md
|
|
331
|
-
- [ ] Planned Major Releases table synchronized with `.ace-
|
|
331
|
+
- [ ] Planned Major Releases table synchronized with `.ace-task/` structure
|
|
332
332
|
- [ ] Completed releases removed from roadmap table
|
|
333
333
|
- [ ] Cross-release dependencies updated and accurate
|
|
334
334
|
- [ ] Front matter `last_reviewed` date updated to today
|
|
@@ -411,10 +411,10 @@ status: [draft|active|archived]
|
|
|
411
411
|
## References
|
|
412
412
|
|
|
413
413
|
- **Roadmap Definition Guide**: `dev-handbook/guides/roadmap-definition.g.md`
|
|
414
|
-
- **Current Roadmap**: `.ace-
|
|
414
|
+
- **Current Roadmap**: `.ace-task/roadmap.md`
|
|
415
415
|
- **Draft Release Workflow**: `wfi://release/draft`
|
|
416
416
|
- **Publish Release Workflow**: `wfi://release/publish`
|
|
417
|
-
- **ace-
|
|
417
|
+
- **ace-task CLI**: For release queries and task analysis
|
|
418
418
|
|
|
419
419
|
---
|
|
420
420
|
|
|
@@ -42,7 +42,7 @@ Systematically update usage documentation files based on user feedback, task req
|
|
|
42
42
|
find . -name "usage.md" -path "*/ux/*" -o -name "usage.md" -path "*/docs/*"
|
|
43
43
|
|
|
44
44
|
# Or check specific task folder
|
|
45
|
-
ls -la .ace-
|
|
45
|
+
ls -la .ace-task/v.*/t/*/ux/usage.md
|
|
46
46
|
```
|
|
47
47
|
* Extract key requirements:
|
|
48
48
|
- What needs to be documented
|
|
@@ -102,7 +102,7 @@ Systematically update usage documentation files based on user feedback, task req
|
|
|
102
102
|
**Commands/Steps**:
|
|
103
103
|
```bash
|
|
104
104
|
# Command with comments
|
|
105
|
-
ace-
|
|
105
|
+
ace-task command --flag value
|
|
106
106
|
```
|
|
107
107
|
|
|
108
108
|
**Expected Output**:
|
|
@@ -159,7 +159,7 @@ Systematically update usage documentation files based on user feedback, task req
|
|
|
159
159
|
### Bash CLI Commands
|
|
160
160
|
Commands without `/` are terminal/bash commands:
|
|
161
161
|
```bash
|
|
162
|
-
ace-
|
|
162
|
+
ace-task command
|
|
163
163
|
```
|
|
164
164
|
|
|
165
165
|
### Claude Code Commands (Slash Commands)
|
|
@@ -469,7 +469,7 @@ feature:
|
|
|
469
469
|
**Available Commands:**
|
|
470
470
|
- `/ace:[command1]` - [Description]
|
|
471
471
|
- `/ace:[command2]` - [Description]
|
|
472
|
-
- `ace-
|
|
472
|
+
- `ace-task [command]` - [CLI equivalent if exists]
|
|
473
473
|
|
|
474
474
|
## Command Types
|
|
475
475
|
|
|
@@ -482,7 +482,7 @@ Commands starting with `/` are executed **within Claude Code**:
|
|
|
482
482
|
### Bash CLI Commands
|
|
483
483
|
Commands without `/` are **terminal/bash commands**:
|
|
484
484
|
```bash
|
|
485
|
-
ace-
|
|
485
|
+
ace-task [command]
|
|
486
486
|
```
|
|
487
487
|
|
|
488
488
|
## Usage Scenarios
|
|
@@ -493,7 +493,7 @@ ace-taskflow [command]
|
|
|
493
493
|
|
|
494
494
|
```bash
|
|
495
495
|
# Step 1: Preparation (bash command)
|
|
496
|
-
ace-
|
|
496
|
+
ace-task list
|
|
497
497
|
|
|
498
498
|
# Step 2: Execution (Claude command)
|
|
499
499
|
/ace:[command]
|
|
@@ -538,13 +538,13 @@ Summary: 2 items completed
|
|
|
538
538
|
[Sample output]
|
|
539
539
|
```
|
|
540
540
|
|
|
541
|
-
### `ace-
|
|
541
|
+
### `ace-task [command]`
|
|
542
542
|
|
|
543
543
|
**Purpose**: [CLI tool purpose]
|
|
544
544
|
|
|
545
545
|
**Usage**:
|
|
546
546
|
```bash
|
|
547
|
-
ace-
|
|
547
|
+
ace-task [command] [options]
|
|
548
548
|
```
|
|
549
549
|
|
|
550
550
|
**Options**:
|
|
@@ -590,7 +590,7 @@ Friday: [Review]
|
|
|
590
590
|
**Solution**:
|
|
591
591
|
```bash
|
|
592
592
|
# Verify installation
|
|
593
|
-
which ace-
|
|
593
|
+
which ace-task
|
|
594
594
|
|
|
595
595
|
# Check workflow exists
|
|
596
596
|
ace-bundle wfi://[workflow] --verify
|
|
@@ -44,8 +44,9 @@ module Ace
|
|
|
44
44
|
Project config: .ace/docs/config.yml
|
|
45
45
|
|
|
46
46
|
Output:
|
|
47
|
-
|
|
48
|
-
|
|
47
|
+
Prints an analysis summary and writes session artifacts to .ace-local/docs/analyze-<id>/
|
|
48
|
+
Key files: analysis.md, metadata.yml, prompt-system.md, prompt-user.md
|
|
49
|
+
Exit codes: 0 (success), 1 (error), 2 (no changes), 3 (analysis error)
|
|
49
50
|
DESC
|
|
50
51
|
|
|
51
52
|
example [
|
|
@@ -34,8 +34,9 @@ module Ace
|
|
|
34
34
|
Project config: .ace/docs/config.yml
|
|
35
35
|
|
|
36
36
|
Output:
|
|
37
|
-
|
|
38
|
-
|
|
37
|
+
Prints report location and writes artifacts under .ace-local/docs/sessions/analyze-consistency-<timestamp>/
|
|
38
|
+
Key files: report.md, metadata.yml, documents.json
|
|
39
|
+
Exit codes: 0 (success), 1 (error)
|
|
39
40
|
DESC
|
|
40
41
|
|
|
41
42
|
example [
|
|
@@ -76,7 +76,9 @@ module Ace
|
|
|
76
76
|
puts "This may take a few minutes for large document sets..." if documents.count > 10
|
|
77
77
|
response = execute_llm_query(prompts, session_dir)
|
|
78
78
|
|
|
79
|
-
|
|
79
|
+
unless response && File.exist?(response) && !File.read(response).strip.empty?
|
|
80
|
+
raise "Consistency analysis did not produce a completed report"
|
|
81
|
+
end
|
|
80
82
|
|
|
81
83
|
# Save metadata for reference
|
|
82
84
|
save_metadata(documents, pattern, session_dir)
|
data/lib/ace/docs/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: ace-docs
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.34.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Michal Czyz
|
|
8
8
|
bindir: exe
|
|
9
9
|
cert_chain: []
|
|
10
|
-
date: 2026-04-
|
|
10
|
+
date: 2026-04-20 00:00:00.000000000 Z
|
|
11
11
|
dependencies:
|
|
12
12
|
- !ruby/object:Gem::Dependency
|
|
13
13
|
name: ace-support-config
|
|
@@ -277,7 +277,6 @@ files:
|
|
|
277
277
|
- handbook/templates/user-docs/user-guide.template.md
|
|
278
278
|
- handbook/workflow-instructions/docs/create-adr.wf.md
|
|
279
279
|
- handbook/workflow-instructions/docs/create-api.wf.md
|
|
280
|
-
- handbook/workflow-instructions/docs/create-cookbook.wf.md
|
|
281
280
|
- handbook/workflow-instructions/docs/create-user.wf.md
|
|
282
281
|
- handbook/workflow-instructions/docs/maintain-adrs.wf.md
|
|
283
282
|
- handbook/workflow-instructions/docs/squash-changelog.wf.md
|
|
@@ -1,434 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
doc-type: workflow
|
|
3
|
-
title: Create Cookbook Workflow Instruction
|
|
4
|
-
purpose: Documentation for ace-docs/handbook/workflow-instructions/docs/create-cookbook.wf.md
|
|
5
|
-
ace-docs:
|
|
6
|
-
last-updated: 2026-02-23
|
|
7
|
-
last-checked: 2026-03-21
|
|
8
|
-
---
|
|
9
|
-
|
|
10
|
-
# Create Cookbook Workflow Instruction
|
|
11
|
-
|
|
12
|
-
**Goal:** Transform identified patterns and insights into reusable, high-quality cookbooks that accelerate future
|
|
13
|
-
development work through systematic documentation of proven procedures.
|
|
14
|
-
|
|
15
|
-
## Prerequisites
|
|
16
|
-
|
|
17
|
-
* Understanding of cookbook purpose and target audience
|
|
18
|
-
* Source material (reflection note, direct observation, or synthesis report)
|
|
19
|
-
* Access to create files in project structure using `create-path` tool
|
|
20
|
-
|
|
21
|
-
## Project Context Loading
|
|
22
|
-
|
|
23
|
-
* Read and follow: `ace-bundle wfi://bundle`
|
|
24
|
-
|
|
25
|
-
## High-Level Execution Plan
|
|
26
|
-
|
|
27
|
-
### Planning Steps
|
|
28
|
-
|
|
29
|
-
* Identify cookbook source material and
|
|
30
|
-
extract core patterns
|
|
31
|
-
* Determine appropriate cookbook category
|
|
32
|
-
and target audience
|
|
33
|
-
* Define cookbook scope and validation
|
|
34
|
-
criteria
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
### Execution Steps
|
|
38
|
-
|
|
39
|
-
* Create cookbook file using embedded
|
|
40
|
-
template and `create-path` tool
|
|
41
|
-
* Populate cookbook sections with
|
|
42
|
-
structured content
|
|
43
|
-
* Validate cookbook completeness and
|
|
44
|
-
actionability
|
|
45
|
-
* Save cookbook in appropriate location
|
|
46
|
-
with standard naming
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
## Process Steps
|
|
50
|
-
|
|
51
|
-
1. **Identify Source Material:**
|
|
52
|
-
* **From Reflection Note:** Extract reusable patterns and procedures
|
|
53
|
-
* **From Direct Input:** Document observed complex procedures
|
|
54
|
-
* **From Synthesis Report:** Capture common workflows and best practices
|
|
55
|
-
* **From User Input:** Accept pattern description and context details
|
|
56
|
-
2. **Select Cookbook Category:** Choose the primary category that best fits the pattern:
|
|
57
|
-
* **integration:** Connecting systems, services, or tools
|
|
58
|
-
* **setup:** Environment configuration and initialization
|
|
59
|
-
* **migration:** Moving between systems, versions, or structures
|
|
60
|
-
* **debugging:** Troubleshooting and problem resolution procedures
|
|
61
|
-
* **automation:** Streamlining repetitive tasks and workflows
|
|
62
|
-
* **pattern:** General development patterns and best practices
|
|
63
|
-
3. **Determine Target Audience:**
|
|
64
|
-
* **beginner:** Basic concepts, detailed explanations, minimal assumptions
|
|
65
|
-
* **intermediate:** Moderate complexity, some background knowledge assumed
|
|
66
|
-
* **advanced:** Complex procedures, expert-level understanding expected
|
|
67
|
-
4. **Define Cookbook Scope:**
|
|
68
|
-
* **Single Pattern:** Focus on one specific procedure or technique
|
|
69
|
-
* **Composite Pattern:** Multiple related procedures in logical sequence
|
|
70
|
-
* **Cross-Category Pattern:** Procedures spanning multiple areas (use primary + secondary categories)
|
|
71
|
-
5. **Generate Cookbook File:** # Create cookbook file (adjust path to your project's documentation structure)
|
|
72
|
-
create-path file "docs/cookbooks/\[category\]-\[descriptive-name\].cookbook.md"
|
|
73
|
-
--title "\[Category\] Cookbook: \[Descriptive Name\]" # Or create manually using the embedded template below
|
|
74
|
-
{: .language-bash}
|
|
75
|
-
|
|
76
|
-
6. **Populate Cookbook Content:** Using the embedded template structure, fill in:
|
|
77
|
-
* **Purpose**: Clear statement of what the cookbook accomplishes
|
|
78
|
-
* **Prerequisites**: System, knowledge, and tool requirements
|
|
79
|
-
* **Steps**: Detailed, actionable procedures with validation
|
|
80
|
-
* **Examples**: Concrete use cases and implementations
|
|
81
|
-
* **Troubleshooting**: Common issues and their solutions
|
|
82
|
-
* **Validation**: Success criteria and testing procedures
|
|
83
|
-
7. **Review and Validate:**
|
|
84
|
-
* Ensure all sections have meaningful content
|
|
85
|
-
* Verify steps are actionable and complete
|
|
86
|
-
* Test examples and validation procedures
|
|
87
|
-
* Confirm naming follows convention: `[category]-[descriptive-name].cookbook.md`
|
|
88
|
-
|
|
89
|
-
## Cookbook Categories & Naming Examples
|
|
90
|
-
|
|
91
|
-
### Category: integration
|
|
92
|
-
|
|
93
|
-
* `integration-oauth-provider.cookbook.md` - OAuth provider setup and configuration
|
|
94
|
-
* `integration-api-gateway.cookbook.md` - API gateway implementation patterns
|
|
95
|
-
* `integration-webhook-handling.cookbook.md` - Webhook endpoint design and testing
|
|
96
|
-
|
|
97
|
-
### Category: setup
|
|
98
|
-
|
|
99
|
-
* `setup-development-environment.cookbook.md` - Complete dev environment configuration
|
|
100
|
-
* `setup-ci-cd-pipeline.cookbook.md` - Continuous integration/deployment setup
|
|
101
|
-
* `setup-monitoring-stack.cookbook.md` - Observability and monitoring configuration
|
|
102
|
-
|
|
103
|
-
### Category: migration
|
|
104
|
-
|
|
105
|
-
* `migration-database-schema.cookbook.md` - Database schema migration procedures
|
|
106
|
-
* `migration-legacy-api.cookbook.md` - Legacy API modernization approach
|
|
107
|
-
* `migration-cloud-infrastructure.cookbook.md` - Infrastructure migration patterns
|
|
108
|
-
|
|
109
|
-
### Category: debugging
|
|
110
|
-
|
|
111
|
-
* `debugging-performance-issues.cookbook.md` - Performance bottleneck investigation
|
|
112
|
-
* `debugging-memory-leaks.cookbook.md` - Memory leak detection and resolution
|
|
113
|
-
* `debugging-distributed-systems.cookbook.md` - Multi-service debugging techniques
|
|
114
|
-
|
|
115
|
-
### Category: automation
|
|
116
|
-
|
|
117
|
-
* `automation-test-data-generation.cookbook.md` - Automated test data creation
|
|
118
|
-
* `automation-deployment-rollback.cookbook.md` - Automated rollback procedures
|
|
119
|
-
* `automation-code-quality-gates.cookbook.md` - Automated quality assurance
|
|
120
|
-
|
|
121
|
-
### Category: pattern
|
|
122
|
-
|
|
123
|
-
* `pattern-error-handling.cookbook.md` - Consistent error handling approaches
|
|
124
|
-
* `pattern-caching-strategy.cookbook.md` - Caching implementation patterns
|
|
125
|
-
* `pattern-service-communication.cookbook.md` - Inter-service communication patterns
|
|
126
|
-
|
|
127
|
-
## Error Handling
|
|
128
|
-
|
|
129
|
-
### Missing Source Material
|
|
130
|
-
|
|
131
|
-
**Symptoms:** No clear pattern or procedure identified **Recovery:**
|
|
132
|
-
|
|
133
|
-
1. Prompt user for pattern details and context
|
|
134
|
-
2. Ask clarifying questions about the procedure
|
|
135
|
-
3. Guide through pattern identification process
|
|
136
|
-
|
|
137
|
-
### Duplicate Cookbook Name
|
|
138
|
-
|
|
139
|
-
**Symptoms:** File already exists with same name **Recovery:**
|
|
140
|
-
|
|
141
|
-
1. Check existing cookbook content for overlap
|
|
142
|
-
2. Suggest alternative naming with version or specialization
|
|
143
|
-
3. Consider merging patterns if highly related
|
|
144
|
-
4. Use `--force` flag only if intentional replacement
|
|
145
|
-
|
|
146
|
-
### Invalid Category
|
|
147
|
-
|
|
148
|
-
**Symptoms:** Category doesn't match standard list **Recovery:**
|
|
149
|
-
|
|
150
|
-
1. Show available categories with descriptions
|
|
151
|
-
2. Help user select most appropriate primary category
|
|
152
|
-
3. Note secondary category in cookbook metadata if cross-category
|
|
153
|
-
|
|
154
|
-
### Incomplete Pattern Documentation
|
|
155
|
-
|
|
156
|
-
**Symptoms:** Pattern lacks sufficient detail for actionable cookbook **Recovery:**
|
|
157
|
-
|
|
158
|
-
1. Request additional context and examples
|
|
159
|
-
2. Break down complex pattern into smaller, manageable steps
|
|
160
|
-
3. Identify missing prerequisites or validation steps
|
|
161
|
-
|
|
162
|
-
<documents>
|
|
163
|
-
<template name="cookbook"># [Category] Cookbook: [Descriptive Name]
|
|
164
|
-
|
|
165
|
-
**Created**: YYYY-MM-DD
|
|
166
|
-
**Last Updated**: YYYY-MM-DD
|
|
167
|
-
**Category**: [integration | setup | migration | debugging | automation | pattern]
|
|
168
|
-
**Audience**: [beginner | intermediate | advanced]
|
|
169
|
-
**Estimated Time**: [X hours/minutes]
|
|
170
|
-
|
|
171
|
-
## Purpose
|
|
172
|
-
|
|
173
|
-
Brief description of what this cookbook accomplishes and why it's valuable.
|
|
174
|
-
|
|
175
|
-
## Prerequisites
|
|
176
|
-
|
|
177
|
-
**System Requirements:**
|
|
178
|
-
- Requirement 1
|
|
179
|
-
- Requirement 2
|
|
180
|
-
|
|
181
|
-
**Knowledge Requirements:**
|
|
182
|
-
- Knowledge area 1
|
|
183
|
-
- Knowledge area 2
|
|
184
|
-
|
|
185
|
-
**Tools & Dependencies:**
|
|
186
|
-
- Tool/dependency 1
|
|
187
|
-
- Tool/dependency 2
|
|
188
|
-
|
|
189
|
-
## Overview
|
|
190
|
-
|
|
191
|
-
High-level summary of the approach and main steps involved.
|
|
192
|
-
|
|
193
|
-
## Steps
|
|
194
|
-
|
|
195
|
-
### Step 1: [Step Title]
|
|
196
|
-
|
|
197
|
-
**Objective**: What this step accomplishes
|
|
198
|
-
|
|
199
|
-
**Commands/Actions:**
|
|
200
|
-
```bash
|
|
201
|
-
# Command examples with explanation
|
|
202
|
-
command --option value
|
|
203
|
-
```
|
|
204
|
-
|
|
205
|
-
**Expected Output:**
|
|
206
|
-
```
|
|
207
|
-
Sample output that confirms success
|
|
208
|
-
```
|
|
209
|
-
|
|
210
|
-
**Validation:**
|
|
211
|
-
```bash
|
|
212
|
-
# Commands to verify this step completed successfully
|
|
213
|
-
verification-command
|
|
214
|
-
```
|
|
215
|
-
|
|
216
|
-
**Troubleshooting:**
|
|
217
|
-
- Common issue 1: Solution
|
|
218
|
-
- Common issue 2: Solution
|
|
219
|
-
|
|
220
|
-
### Step 2: [Step Title]
|
|
221
|
-
|
|
222
|
-
**Objective**: What this step accomplishes
|
|
223
|
-
|
|
224
|
-
**Commands/Actions:**
|
|
225
|
-
```bash
|
|
226
|
-
# Additional commands
|
|
227
|
-
```
|
|
228
|
-
|
|
229
|
-
**Expected Output:**
|
|
230
|
-
```
|
|
231
|
-
Expected results
|
|
232
|
-
```
|
|
233
|
-
|
|
234
|
-
**Validation:**
|
|
235
|
-
```bash
|
|
236
|
-
# Verification commands
|
|
237
|
-
```
|
|
238
|
-
|
|
239
|
-
**Troubleshooting:**
|
|
240
|
-
- Issue: Solution
|
|
241
|
-
|
|
242
|
-
## Validation & Testing
|
|
243
|
-
|
|
244
|
-
### Final Validation Steps
|
|
245
|
-
|
|
246
|
-
1. **System Check:**
|
|
247
|
-
```bash
|
|
248
|
-
# Commands to verify overall system state
|
|
249
|
-
```
|
|
250
|
-
|
|
251
|
-
2. **Functional Test:**
|
|
252
|
-
```bash
|
|
253
|
-
# Commands to test functionality end-to-end
|
|
254
|
-
```
|
|
255
|
-
|
|
256
|
-
3. **Performance Check** (if applicable):
|
|
257
|
-
```bash
|
|
258
|
-
# Commands to verify performance expectations
|
|
259
|
-
```
|
|
260
|
-
|
|
261
|
-
### Success Criteria
|
|
262
|
-
|
|
263
|
-
- [ ] Criterion 1: Description of what should be working
|
|
264
|
-
- [ ] Criterion 2: Another measurable outcome
|
|
265
|
-
- [ ] Criterion 3: Final validation point
|
|
266
|
-
|
|
267
|
-
## Examples
|
|
268
|
-
|
|
269
|
-
### Example 1: [Scenario Name]
|
|
270
|
-
|
|
271
|
-
**Context**: Specific use case or scenario
|
|
272
|
-
|
|
273
|
-
**Implementation:**
|
|
274
|
-
```bash
|
|
275
|
-
# Specific commands for this example
|
|
276
|
-
```
|
|
277
|
-
|
|
278
|
-
**Result**: What the outcome looks like
|
|
279
|
-
|
|
280
|
-
### Example 2: [Another Scenario]
|
|
281
|
-
|
|
282
|
-
**Context**: Different use case
|
|
283
|
-
|
|
284
|
-
**Implementation:**
|
|
285
|
-
```bash
|
|
286
|
-
# Alternative approach or configuration
|
|
287
|
-
```
|
|
288
|
-
|
|
289
|
-
**Result**: Expected outcome
|
|
290
|
-
|
|
291
|
-
## Templates & Code Snippets
|
|
292
|
-
|
|
293
|
-
### Configuration Template
|
|
294
|
-
|
|
295
|
-
```yaml
|
|
296
|
-
# Sample configuration file
|
|
297
|
-
key: value
|
|
298
|
-
section:
|
|
299
|
-
nested_key: nested_value
|
|
300
|
-
```
|
|
301
|
-
|
|
302
|
-
### Code Template
|
|
303
|
-
|
|
304
|
-
```ruby
|
|
305
|
-
# Sample code implementation
|
|
306
|
-
class ExampleClass
|
|
307
|
-
def example_method
|
|
308
|
-
# Implementation
|
|
309
|
-
end
|
|
310
|
-
end
|
|
311
|
-
```
|
|
312
|
-
|
|
313
|
-
## Common Patterns
|
|
314
|
-
|
|
315
|
-
### Pattern 1: [Pattern Name]
|
|
316
|
-
|
|
317
|
-
**When to use**: Specific conditions or scenarios
|
|
318
|
-
**How to implement**: Brief implementation guide
|
|
319
|
-
**Example**: Quick code or command example
|
|
320
|
-
|
|
321
|
-
### Pattern 2: [Another Pattern]
|
|
322
|
-
|
|
323
|
-
**When to use**: Different scenario
|
|
324
|
-
**How to implement**: Implementation approach
|
|
325
|
-
**Example**: Sample usage
|
|
326
|
-
|
|
327
|
-
## Troubleshooting
|
|
328
|
-
|
|
329
|
-
### Error: [Common Error Message]
|
|
330
|
-
|
|
331
|
-
**Symptoms**: How this error manifests
|
|
332
|
-
**Cause**: Root cause of the issue
|
|
333
|
-
**Solution**: Step-by-step fix
|
|
334
|
-
**Prevention**: How to avoid in the future
|
|
335
|
-
|
|
336
|
-
### Issue: [Common Problem]
|
|
337
|
-
|
|
338
|
-
**Symptoms**: Observable behavior
|
|
339
|
-
**Diagnosis**: How to confirm this is the issue
|
|
340
|
-
**Resolution**: Solution steps
|
|
341
|
-
**Verification**: How to confirm it's fixed
|
|
342
|
-
|
|
343
|
-
## Related Resources
|
|
344
|
-
|
|
345
|
-
### Documentation Links
|
|
346
|
-
|
|
347
|
-
- [Official docs link](url)
|
|
348
|
-
- [API reference](url)
|
|
349
|
-
- [Community guide](url)
|
|
350
|
-
|
|
351
|
-
### Other Cookbooks
|
|
352
|
-
|
|
353
|
-
- [Related cookbook 1](link)
|
|
354
|
-
- [Related cookbook 2](link)
|
|
355
|
-
|
|
356
|
-
### External Tools & Resources
|
|
357
|
-
|
|
358
|
-
- [Tool name](url): Description of how it helps
|
|
359
|
-
- [Resource name](url): What it provides
|
|
360
|
-
|
|
361
|
-
## Version History
|
|
362
|
-
|
|
363
|
-
### v1.0 (YYYY-MM-DD)
|
|
364
|
-
- Initial version
|
|
365
|
-
- Core steps documented
|
|
366
|
-
|
|
367
|
-
### v1.1 (YYYY-MM-DD)
|
|
368
|
-
- Added troubleshooting section
|
|
369
|
-
- Updated validation steps
|
|
370
|
-
|
|
371
|
-
## Feedback & Improvements
|
|
372
|
-
|
|
373
|
-
**Known Limitations:**
|
|
374
|
-
- Limitation 1: Description and potential workaround
|
|
375
|
-
- Limitation 2: Impact and mitigation
|
|
376
|
-
|
|
377
|
-
**Future Enhancements:**
|
|
378
|
-
- Enhancement idea 1
|
|
379
|
-
- Enhancement idea 2
|
|
380
|
-
|
|
381
|
-
**Contributing:**
|
|
382
|
-
If you find issues or improvements for this cookbook, please:
|
|
383
|
-
1. Document the specific issue or enhancement
|
|
384
|
-
2. Test any proposed changes
|
|
385
|
-
3. Update relevant sections
|
|
386
|
-
4. Increment version number
|
|
387
|
-
|
|
388
|
-
---
|
|
389
|
-
|
|
390
|
-
*This cookbook is part of the development workflow documentation.*
|
|
391
|
-
</template>
|
|
392
|
-
</documents>
|
|
393
|
-
|
|
394
|
-
## Input
|
|
395
|
-
|
|
396
|
-
* Source material (reflection note path, synthesis report, or direct pattern description)
|
|
397
|
-
* Cookbook category selection
|
|
398
|
-
* Target audience level
|
|
399
|
-
* Pattern scope and context
|
|
400
|
-
|
|
401
|
-
## Output / Success Criteria
|
|
402
|
-
|
|
403
|
-
* Cookbook file created in project documentation directory (e.g., `docs/cookbooks/`)
|
|
404
|
-
* File follows naming convention: `[category]-[descriptive-name].cookbook.md`
|
|
405
|
-
* All template sections populated with meaningful content
|
|
406
|
-
* Cookbook is actionable and self-contained
|
|
407
|
-
* Validation procedures included and tested
|
|
408
|
-
* Related resources and cross-references updated
|
|
409
|
-
|
|
410
|
-
## Common Patterns
|
|
411
|
-
|
|
412
|
-
### Template-Driven Creation
|
|
413
|
-
|
|
414
|
-
1. Use `create-path` tool with cookbook template
|
|
415
|
-
2. Fill template sections systematically
|
|
416
|
-
3. Validate completeness against checklist
|
|
417
|
-
4. Test examples and procedures
|
|
418
|
-
|
|
419
|
-
### Pattern Extraction
|
|
420
|
-
|
|
421
|
-
1. Analyze source material for recurring procedures
|
|
422
|
-
2. Identify decision points and alternatives
|
|
423
|
-
3. Document assumptions and prerequisites
|
|
424
|
-
4. Create concrete examples and test cases
|
|
425
|
-
|
|
426
|
-
## Related Workflows
|
|
427
|
-
|
|
428
|
-
* Integration with `create-path` tool for file generation (if available in your project)
|
|
429
|
-
|
|
430
|
-
* * *
|
|
431
|
-
|
|
432
|
-
This workflow systematically transforms development insights into reusable cookbooks, building a knowledge base that
|
|
433
|
-
improves team efficiency and consistency across projects.
|
|
434
|
-
|