@comfanion/workflow 4.38.4-dev.1 → 4.39.0-dev.0
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.
- package/package.json +1 -1
- package/src/build-info.json +2 -2
- package/src/opencode/skills/acceptance-criteria/SKILL.md +58 -176
- package/src/opencode/skills/architecture-design/SKILL.md +86 -576
- package/src/opencode/skills/archiving/SKILL.md +60 -140
- package/src/opencode/skills/coding-standards/SKILL.md +113 -434
- package/src/opencode/skills/coding-standards/what-to-document.md +512 -0
- package/src/opencode/skills/database-design/SKILL.md +94 -778
- package/src/opencode/skills/database-design/indexing.md +187 -0
- package/src/opencode/skills/database-design/migrations.md +239 -0
- package/src/opencode/skills/database-design/schema-design.md +319 -0
- package/src/opencode/skills/doc-todo/SKILL.md +35 -27
- package/src/opencode/skills/epic-writing/SKILL.md +156 -244
- package/src/opencode/skills/epic-writing/template.md +11 -1
- package/src/opencode/skills/methodologies/SKILL.md +91 -354
- package/src/opencode/skills/methodologies/define.md +336 -0
- package/src/opencode/skills/methodologies/diagnose.md +374 -0
- package/src/opencode/skills/methodologies/empathize.md +253 -0
- package/src/opencode/skills/methodologies/ideate.md +458 -0
- package/src/opencode/skills/prd-writing/SKILL.md +162 -366
- package/src/opencode/skills/prd-writing/template.md +178 -48
- package/src/opencode/skills/requirements-gathering/SKILL.md +102 -117
- package/src/opencode/skills/requirements-gathering/template.md +97 -17
- package/src/opencode/skills/sprint-planning/SKILL.md +76 -225
- package/src/opencode/skills/sprint-planning/template.yaml +8 -0
- package/src/opencode/skills/story-writing/SKILL.md +76 -210
- package/src/opencode/skills/story-writing/template.md +10 -1
- package/src/opencode/skills/test-design/SKILL.md +78 -84
- package/src/opencode/skills/test-design/test-strategy.md +279 -0
- package/src/opencode/skills/test-design/unit-tests-mocking.md +247 -0
- package/src/opencode/skills/test-design/unit-tests-patterns.md +181 -0
- package/src/opencode/skills/test-design/unit-tests.md +117 -0
- package/src/opencode/skills/unit-writing/SKILL.md +119 -377
- package/src/opencode/skills/module-documentation/SKILL.md +0 -224
- package/src/opencode/skills/module-documentation/template.md +0 -139
- /package/src/opencode/skills/test-design/{template-integration.md → templates/template-integration.md} +0 -0
- /package/src/opencode/skills/test-design/{template-module.md → templates/template-module.md} +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: archiving
|
|
3
|
-
description: Use when archiving outdated
|
|
3
|
+
description: Archive outdated documents to docs/archive/ while preserving history, version, and reason for archiving. Use when retiring documents, archiving old versions, cleaning up docs, or when user mentions "archive", "outdated docs", "retire document", or "move to archive".
|
|
4
4
|
license: MIT
|
|
5
5
|
compatibility: opencode
|
|
6
6
|
metadata:
|
|
@@ -8,173 +8,93 @@ metadata:
|
|
|
8
8
|
agents: [all]
|
|
9
9
|
---
|
|
10
10
|
|
|
11
|
-
# Document
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
11
|
+
# Document Archiving Skill
|
|
12
|
+
|
|
13
|
+
```xml
|
|
14
|
+
<archiving>
|
|
15
|
+
<definition>Archive outdated documents while preserving history</definition>
|
|
16
|
+
|
|
17
|
+
<principle>Documents are never deleted, only archived - every document has history value</principle>
|
|
18
|
+
|
|
19
|
+
<structure>
|
|
20
|
+
<root>docs/archive/</root>
|
|
21
|
+
<folders>research/, prd/, architecture/, modules/, coding-standards/, sprint-artifacts/</folders>
|
|
22
|
+
</structure>
|
|
23
|
+
|
|
24
|
+
<when_to_archive>
|
|
25
|
+
<research>Superseded by new research, >1 year old</research>
|
|
26
|
+
<prd>Major version change, scope pivot</prd>
|
|
27
|
+
<architecture>Major redesign, tech stack change</architecture>
|
|
28
|
+
<module_docs>Module deprecated or merged</module_docs>
|
|
29
|
+
<coding_standards>Standards significantly changed</coding_standards>
|
|
30
|
+
<sprint_artifacts>Sprint completed + retrospective done</sprint_artifacts>
|
|
31
|
+
</when_to_archive>
|
|
32
|
+
|
|
33
|
+
<process>
|
|
34
|
+
<step1>Add archive metadata (archived: true, archived_date, archived_reason, superseded_by)</step1>
|
|
35
|
+
<step2>Rename with date suffix (document.md → document-YYYY-MM-DD.md)</step2>
|
|
36
|
+
<step3>Move to archive (docs/[path]/ → docs/archive/[path]/)</step3>
|
|
37
|
+
<step4>Update references in other docs</step4>
|
|
38
|
+
<step5>Update archive index (docs/archive/README.md)</step5>
|
|
39
|
+
</process>
|
|
40
|
+
|
|
41
|
+
<metadata_template>
|
|
42
|
+
archived: true
|
|
43
|
+
archived_date: YYYY-MM-DD
|
|
44
|
+
archived_reason: "reason"
|
|
45
|
+
superseded_by: "path to new doc"
|
|
46
|
+
original_path: "original path"
|
|
47
|
+
original_version: "version"
|
|
48
|
+
</metadata_template>
|
|
49
|
+
|
|
50
|
+
<dont_archive>Current sprint artifacts, Active research, Current PRD/Architecture, Templates</dont_archive>
|
|
51
|
+
</archiving>
|
|
36
52
|
```
|
|
37
53
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
### When to Archive
|
|
41
|
-
|
|
42
|
-
| Document Type | Archive When |
|
|
43
|
-
|--------------|--------------|
|
|
44
|
-
| Research | Superseded by new research, > 1 year old |
|
|
45
|
-
| PRD | Major version change, scope pivot |
|
|
46
|
-
| Architecture | Major redesign, tech stack change |
|
|
47
|
-
| Module docs | Module deprecated or merged |
|
|
48
|
-
| Coding standards | Standards significantly changed |
|
|
49
|
-
| Sprint artifacts | Sprint completed + retrospective done |
|
|
50
|
-
|
|
51
|
-
### Archive Process
|
|
52
|
-
|
|
53
|
-
1. **Add archive metadata** to the document:
|
|
54
|
-
```markdown
|
|
55
|
-
---
|
|
56
|
-
archived: true
|
|
57
|
-
archived_date: YYYY-MM-DD
|
|
58
|
-
archived_reason: [reason]
|
|
59
|
-
superseded_by: [path to new doc] # if applicable
|
|
60
|
-
---
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
2. **Rename with date suffix**:
|
|
64
|
-
- `document.md` → `document-YYYY-MM-DD.md`
|
|
65
|
-
|
|
66
|
-
3. **Move to archive**:
|
|
67
|
-
- From: `docs/[path]/document.md`
|
|
68
|
-
- To: `docs/archive/[path]/document-YYYY-MM-DD.md`
|
|
69
|
-
|
|
70
|
-
4. **Update references**:
|
|
71
|
-
- Update any docs that linked to archived doc
|
|
72
|
-
- Add "Archived" note with link to new version
|
|
73
|
-
|
|
74
|
-
5. **Update archive index**:
|
|
75
|
-
- Add entry to `docs/archive/README.md`
|
|
76
|
-
|
|
77
|
-
## Archive Metadata Template
|
|
54
|
+
---
|
|
78
55
|
|
|
79
|
-
|
|
56
|
+
## Example: Archive PRD v1.0
|
|
80
57
|
|
|
81
58
|
```markdown
|
|
82
59
|
---
|
|
83
60
|
archived: true
|
|
84
|
-
archived_date: 2026-01-
|
|
85
|
-
archived_reason: "Superseded by v2.0 after
|
|
86
|
-
superseded_by: "../
|
|
87
|
-
original_path: "docs/
|
|
88
|
-
original_version: "1.
|
|
61
|
+
archived_date: 2026-01-29
|
|
62
|
+
archived_reason: "Superseded by v2.0 after scope pivot"
|
|
63
|
+
superseded_by: "../prd.md"
|
|
64
|
+
original_path: "docs/prd.md"
|
|
65
|
+
original_version: "1.0"
|
|
89
66
|
---
|
|
90
67
|
|
|
91
|
-
#
|
|
68
|
+
# Product Requirements Document (ARCHIVED)
|
|
92
69
|
|
|
93
|
-
> **ARCHIVED:** This document was archived on 2026-01-
|
|
94
|
-
> **Reason:** Superseded by v2.0 after
|
|
95
|
-
> **Current Version:** [
|
|
70
|
+
> **ARCHIVED:** This document was archived on 2026-01-29.
|
|
71
|
+
> **Reason:** Superseded by v2.0 after scope pivot
|
|
72
|
+
> **Current Version:** [prd.md](../prd.md)
|
|
96
73
|
|
|
97
74
|
---
|
|
98
75
|
|
|
99
76
|
[Original content below]
|
|
100
77
|
```
|
|
101
78
|
|
|
102
|
-
## Archive Index
|
|
79
|
+
## Archive Index Structure
|
|
103
80
|
|
|
104
81
|
```markdown
|
|
105
82
|
# Documentation Archive
|
|
106
83
|
|
|
107
|
-
This directory contains archived documents that are no longer current
|
|
108
|
-
but preserved for historical reference.
|
|
109
|
-
|
|
110
|
-
## Archive Policy
|
|
111
|
-
|
|
112
|
-
- Documents are archived, never deleted
|
|
113
|
-
- Each archived doc includes reason and date
|
|
114
|
-
- Superseding documents are linked
|
|
115
|
-
- Archive is searchable by date and type
|
|
116
|
-
|
|
117
84
|
## Recently Archived
|
|
118
85
|
|
|
119
86
|
| Document | Type | Archived | Reason |
|
|
120
87
|
|----------|------|----------|--------|
|
|
121
|
-
|
|
|
88
|
+
| prd-v1.0 | PRD | 2026-01-29 | v2.0 released |
|
|
89
|
+
| architecture-v1.5 | Architecture | 2026-01-20 | Tech stack change |
|
|
122
90
|
|
|
123
91
|
## Archive by Type
|
|
124
92
|
|
|
125
93
|
### PRD Versions
|
|
126
|
-
|
|
127
|
-
|---------|------|--------|------|
|
|
128
|
-
|
|
129
|
-
### Architecture Versions
|
|
130
|
-
| Version | Date | Reason | Link |
|
|
131
|
-
|---------|------|--------|------|
|
|
132
|
-
|
|
133
|
-
### Research
|
|
134
|
-
| Topic | Date | Reason | Link |
|
|
135
|
-
|-------|------|--------|------|
|
|
136
|
-
|
|
137
|
-
### Module Documentation
|
|
138
|
-
| Module | Date | Reason | Link |
|
|
139
|
-
|--------|------|--------|------|
|
|
140
|
-
|
|
141
|
-
### Coding Standards
|
|
142
|
-
| File | Date | Reason | Link |
|
|
143
|
-
|------|------|--------|------|
|
|
144
|
-
|
|
145
|
-
## Retrieval
|
|
94
|
+
- [prd-v1.0-2026-01-29.md](./prd/prd-v1.0-2026-01-29.md) - Superseded by v2.0
|
|
146
95
|
|
|
147
|
-
|
|
148
|
-
1
|
|
149
|
-
2. Search by date in folder names
|
|
150
|
-
3. Use git history for pre-archive versions
|
|
96
|
+
### Sprint Artifacts
|
|
97
|
+
- [sprint-1/](./sprint-artifacts/sprint-1/) - Completed 2026-01-15
|
|
151
98
|
```
|
|
152
99
|
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
### Archive Single Document
|
|
156
|
-
```bash
|
|
157
|
-
# Move and rename
|
|
158
|
-
mv docs/research/topic.md docs/archive/research/topic-$(date +%Y-%m-%d).md
|
|
159
|
-
```
|
|
160
|
-
|
|
161
|
-
### Archive Sprint (after completion)
|
|
162
|
-
```bash
|
|
163
|
-
# Move entire sprint folder
|
|
164
|
-
mv docs/sprint-artifacts/sprint-N docs/archive/sprint-artifacts/sprint-N
|
|
165
|
-
```
|
|
166
|
-
|
|
167
|
-
## Validation Before Archiving
|
|
168
|
-
|
|
169
|
-
- [ ] Document has archive metadata added
|
|
170
|
-
- [ ] Superseding document exists (if applicable)
|
|
171
|
-
- [ ] References to archived doc updated
|
|
172
|
-
- [ ] Archive index updated
|
|
173
|
-
- [ ] No broken links in main docs
|
|
174
|
-
|
|
175
|
-
## What NOT to Archive
|
|
176
|
-
|
|
177
|
-
- Current sprint artifacts (until sprint complete)
|
|
178
|
-
- Active research (until superseded)
|
|
179
|
-
- Current PRD/Architecture (until new version approved)
|
|
180
|
-
- Templates (these don't get archived)
|
|
100
|
+
See `template-change-proposal.md` for full format.
|