@orderful/droid 0.25.2 → 0.26.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/.claude-plugin/marketplace.json +114 -0
- package/.github/workflows/ci.yml +20 -0
- package/AGENTS.md +53 -0
- package/CHANGELOG.md +44 -0
- package/README.md +30 -4
- package/dist/bin/droid.js +62 -51
- package/dist/index.js +9 -1
- package/dist/lib/skill-config.d.ts.map +1 -1
- package/dist/tools/README.md +1 -1
- package/dist/tools/brain/.claude-plugin/plugin.json +16 -0
- package/dist/tools/brain/commands/brain.md +1 -1
- package/dist/tools/brain/commands/scratchpad.md +1 -1
- package/dist/tools/brain/skills/droid-brain/SKILL.md +1 -1
- package/dist/tools/brain/skills/droid-brain-obsidian/SKILL.md +1 -1
- package/dist/tools/coach/.claude-plugin/plugin.json +16 -0
- package/dist/tools/coach/commands/coach.md +1 -1
- package/dist/tools/coach/skills/droid-coach/SKILL.md +1 -1
- package/dist/tools/code-review/.claude-plugin/plugin.json +16 -0
- package/dist/tools/code-review/commands/code-review.md +1 -1
- package/dist/tools/code-review/skills/droid-code-review/SKILL.md +1 -1
- package/dist/tools/codex/.claude-plugin/plugin.json +16 -0
- package/dist/tools/codex/TOOL.yaml +2 -2
- package/dist/tools/codex/commands/codex.md +1 -1
- package/dist/tools/codex/skills/droid-codex/SKILL.md +1 -1
- package/dist/tools/comments/.claude-plugin/plugin.json +16 -0
- package/dist/tools/comments/commands/comments.md +1 -1
- package/dist/tools/comments/skills/droid-comments/SKILL.md +1 -1
- package/dist/tools/droid/.claude-plugin/plugin.json +15 -0
- package/dist/tools/droid/TOOL.yaml +1 -1
- package/dist/tools/droid/skills/droid/SKILL.md +1 -1
- package/dist/tools/project/.claude-plugin/plugin.json +16 -0
- package/dist/tools/project/commands/project.md +1 -1
- package/dist/tools/project/skills/droid-project/SKILL.md +1 -1
- package/dist/tools/tech-design/.claude-plugin/plugin.json +16 -0
- package/dist/tools/tech-design/TOOL.yaml +18 -0
- package/dist/tools/tech-design/commands/tech-design.md +93 -0
- package/dist/tools/tech-design/skills/droid-tech-design/SKILL.md +218 -0
- package/dist/tools/tech-design/skills/droid-tech-design/references/draft.md +321 -0
- package/dist/tools/tech-design/skills/droid-tech-design/references/gaps.md +328 -0
- package/dist/tools/tech-design/skills/droid-tech-design/references/publish.md +409 -0
- package/dist/tools/tech-design/skills/droid-tech-design/references/research-doc-template.md +129 -0
- package/dist/tools/tech-design/skills/droid-tech-design/references/rollup-template.md +55 -0
- package/dist/tools/tech-design/skills/droid-tech-design/references/start.md +353 -0
- package/dist/tools/tech-design/skills/droid-tech-design/references/think.md +356 -0
- package/dist/tools/tech-design/skills/droid-tech-design/references/thought-doc-template.md +72 -0
- package/package.json +3 -2
- package/scripts/build-plugins.ts +207 -0
- package/src/lib/skill-config.ts +95 -57
- package/src/lib/skills.ts +2 -2
- package/src/tools/README.md +1 -1
- package/src/tools/brain/.claude-plugin/plugin.json +16 -0
- package/src/tools/brain/commands/brain.md +1 -1
- package/src/tools/brain/commands/scratchpad.md +1 -1
- package/src/tools/brain/skills/droid-brain/SKILL.md +1 -1
- package/src/tools/brain/skills/droid-brain-obsidian/SKILL.md +1 -1
- package/src/tools/coach/.claude-plugin/plugin.json +16 -0
- package/src/tools/coach/commands/coach.md +1 -1
- package/src/tools/coach/skills/droid-coach/SKILL.md +1 -1
- package/src/tools/code-review/.claude-plugin/plugin.json +16 -0
- package/src/tools/code-review/commands/code-review.md +1 -1
- package/src/tools/code-review/skills/droid-code-review/SKILL.md +1 -1
- package/src/tools/codex/.claude-plugin/plugin.json +16 -0
- package/src/tools/codex/TOOL.yaml +2 -2
- package/src/tools/codex/commands/codex.md +1 -1
- package/src/tools/codex/skills/droid-codex/SKILL.md +1 -1
- package/src/tools/comments/.claude-plugin/plugin.json +16 -0
- package/src/tools/comments/commands/comments.md +1 -1
- package/src/tools/comments/skills/droid-comments/SKILL.md +1 -1
- package/src/tools/droid/.claude-plugin/plugin.json +15 -0
- package/src/tools/droid/TOOL.yaml +1 -1
- package/src/tools/droid/skills/droid/SKILL.md +1 -1
- package/src/tools/project/.claude-plugin/plugin.json +16 -0
- package/src/tools/project/commands/project.md +1 -1
- package/src/tools/project/skills/droid-project/SKILL.md +1 -1
- package/src/tools/tech-design/.claude-plugin/plugin.json +16 -0
- package/src/tools/tech-design/TOOL.yaml +18 -0
- package/src/tools/tech-design/commands/tech-design.md +93 -0
- package/src/tools/tech-design/skills/droid-tech-design/SKILL.md +218 -0
- package/src/tools/tech-design/skills/droid-tech-design/references/draft.md +321 -0
- package/src/tools/tech-design/skills/droid-tech-design/references/gaps.md +328 -0
- package/src/tools/tech-design/skills/droid-tech-design/references/publish.md +409 -0
- package/src/tools/tech-design/skills/droid-tech-design/references/research-doc-template.md +129 -0
- package/src/tools/tech-design/skills/droid-tech-design/references/rollup-template.md +55 -0
- package/src/tools/tech-design/skills/droid-tech-design/references/start.md +353 -0
- package/src/tools/tech-design/skills/droid-tech-design/references/think.md +356 -0
- package/src/tools/tech-design/skills/droid-tech-design/references/thought-doc-template.md +72 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
name: codex
|
|
2
2
|
description: "Shared organizational knowledge - PRDs, tech designs, domains, proposals, patterns, and explored topics. Use when loading project context, searching codex, capturing decisions, or creating new entries."
|
|
3
|
-
version: 0.1.
|
|
3
|
+
version: 0.1.5
|
|
4
4
|
status: beta
|
|
5
5
|
|
|
6
6
|
includes:
|
|
@@ -24,7 +24,7 @@ prerequisites:
|
|
|
24
24
|
config_schema:
|
|
25
25
|
codex_repo:
|
|
26
26
|
type: string
|
|
27
|
-
description: Path to local orderful-codex repository
|
|
27
|
+
description: Path to local orderful-codex repository
|
|
28
28
|
required: true
|
|
29
29
|
default: "~/src/github.com/orderful-codex"
|
|
30
30
|
freshness_days:
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
description: Shared organizational knowledge - PRDs, tech designs, patterns, domains, proposals, and explored topics
|
|
3
3
|
argument-hint: "[projects | domains | proposals | patterns | topics | {name} | search {query} | new {type} {name} | decision {text}]"
|
|
4
|
-
allowed-tools: Read, Write, Edit, Glob, Grep, Bash(gh:*), Bash(git:*), Bash(ls:*), Bash(mkdir:*)
|
|
4
|
+
allowed-tools: [Read, Write, Edit, Glob, Grep, Bash(gh:*), Bash(git:*), Bash(ls:*), Bash(mkdir:*)]
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# /codex
|
|
@@ -7,7 +7,7 @@ globs:
|
|
|
7
7
|
- "**/CONTEXT.md"
|
|
8
8
|
- "**/DECISIONS.md"
|
|
9
9
|
alwaysApply: false
|
|
10
|
-
allowed-tools: Read, Write, Edit, Glob, Grep, Bash(gh:*), Bash(git:*), Bash(ls:*), Bash(mkdir:*)
|
|
10
|
+
allowed-tools: [Read, Write, Edit, Glob, Grep, Bash(gh:*), Bash(git:*), Bash(ls:*), Bash(mkdir:*)]
|
|
11
11
|
---
|
|
12
12
|
|
|
13
13
|
# Codex Skill
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "droid-comments",
|
|
3
|
+
"version": "0.2.6",
|
|
4
|
+
"description": "Enable inline conversations using @droid/@user markers. Tag @droid to ask the AI, AI responds with @{your-name}. Use /comments check to address markers, /comments cleanup to remove resolved threads. Ideal for code review notes and async collaboration.",
|
|
5
|
+
"author": {
|
|
6
|
+
"name": "Orderful",
|
|
7
|
+
"url": "https://github.com/orderful"
|
|
8
|
+
},
|
|
9
|
+
"repository": "https://github.com/orderful/droid",
|
|
10
|
+
"license": "MIT",
|
|
11
|
+
"keywords": [
|
|
12
|
+
"droid",
|
|
13
|
+
"ai",
|
|
14
|
+
"comments"
|
|
15
|
+
]
|
|
16
|
+
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
description: Check and respond to inline @droid comments in code and docs
|
|
3
3
|
argument-hint: "[check [{path}] | cleanup]"
|
|
4
|
-
allowed-tools: Read, Edit, Grep, Glob, Bash(git diff:*), Bash(git status:*)
|
|
4
|
+
allowed-tools: [Read, Edit, Grep, Glob, Bash(git diff:*), Bash(git status:*)]
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# /comments - Check and respond to inline comments
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "droid",
|
|
3
|
+
"version": "0.4.0",
|
|
4
|
+
"description": "Core droid meta-skill for update awareness and tool discovery. Checks for updates and helps users find the right tools.",
|
|
5
|
+
"author": {
|
|
6
|
+
"name": "Orderful",
|
|
7
|
+
"url": "https://github.com/orderful"
|
|
8
|
+
},
|
|
9
|
+
"repository": "https://github.com/orderful/droid",
|
|
10
|
+
"license": "MIT",
|
|
11
|
+
"keywords": [
|
|
12
|
+
"droid",
|
|
13
|
+
"ai"
|
|
14
|
+
]
|
|
15
|
+
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
name: droid
|
|
2
2
|
description: "Core droid meta-skill for update awareness and tool discovery. Checks for updates and helps users find the right tools."
|
|
3
|
-
version: 0.
|
|
3
|
+
version: 0.4.0
|
|
4
4
|
status: beta
|
|
5
5
|
|
|
6
6
|
# System tool - always stays current regardless of auto-update settings
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "droid-project",
|
|
3
|
+
"version": "0.2.0",
|
|
4
|
+
"description": "Manage project context files for persistent AI memory across sessions. Load, update, or create project context before working on multi-session features.",
|
|
5
|
+
"author": {
|
|
6
|
+
"name": "Orderful",
|
|
7
|
+
"url": "https://github.com/orderful"
|
|
8
|
+
},
|
|
9
|
+
"repository": "https://github.com/orderful/droid",
|
|
10
|
+
"license": "MIT",
|
|
11
|
+
"keywords": [
|
|
12
|
+
"droid",
|
|
13
|
+
"ai",
|
|
14
|
+
"project"
|
|
15
|
+
]
|
|
16
|
+
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
description: Manage project context files for persistent AI memory across sessions
|
|
3
3
|
argument-hint: "[{keywords} | update | create {name}]"
|
|
4
|
-
allowed-tools: Read, Write, Edit, Glob, Bash(mkdir:*), Bash(ls:*)
|
|
4
|
+
allowed-tools: [Read, Write, Edit, Glob, Bash(mkdir:*), Bash(ls:*)]
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# /project
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "droid-tech-design",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Technical design authoring tool for engineers. Create structured tech design docs with /tech-design start, iterate in brain, publish to codex. Three-document approach: research doc (codebase discoveries) + thought doc (design workspace) + roll-up (clean summary for review).",
|
|
5
|
+
"author": {
|
|
6
|
+
"name": "Orderful",
|
|
7
|
+
"url": "https://github.com/orderful"
|
|
8
|
+
},
|
|
9
|
+
"repository": "https://github.com/orderful/droid",
|
|
10
|
+
"license": "MIT",
|
|
11
|
+
"keywords": [
|
|
12
|
+
"droid",
|
|
13
|
+
"ai",
|
|
14
|
+
"tech-design"
|
|
15
|
+
]
|
|
16
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
name: tech-design
|
|
2
|
+
description: "Technical design authoring tool for engineers. Create structured tech design docs with /tech-design start, iterate in brain, publish to codex. Three-document approach: research doc (codebase discoveries) + thought doc (design workspace) + roll-up (clean summary for review)."
|
|
3
|
+
version: 0.1.0
|
|
4
|
+
status: beta
|
|
5
|
+
|
|
6
|
+
includes:
|
|
7
|
+
skills:
|
|
8
|
+
- name: droid-tech-design
|
|
9
|
+
required: true
|
|
10
|
+
commands:
|
|
11
|
+
- tech-design
|
|
12
|
+
agents: []
|
|
13
|
+
|
|
14
|
+
dependencies:
|
|
15
|
+
- brain
|
|
16
|
+
- codex
|
|
17
|
+
|
|
18
|
+
config_schema: {}
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Write, iterate, and publish technical design documents using a two-document approach - messy thought docs in brain, clean roll-ups in codex
|
|
3
|
+
argument-hint: "[start --from codex:{project} | draft [section] | think [topic] | gaps | publish]"
|
|
4
|
+
allowed-tools: [Read, Write, Edit, Glob, Grep, Bash(gh:*), Bash(git:*), Bash(mkdir:*), Task]
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# /tech-design
|
|
8
|
+
|
|
9
|
+
Entry point for technical design authoring. See the **tech-design skill** for full behavior.
|
|
10
|
+
|
|
11
|
+
> Tech designs are where architectural decisions get made. Make them AI-friendly.
|
|
12
|
+
|
|
13
|
+
## Arguments
|
|
14
|
+
|
|
15
|
+
$ARGUMENTS
|
|
16
|
+
|
|
17
|
+
## Why `/tech-design` not `/design`?
|
|
18
|
+
|
|
19
|
+
Leaves `/design` open for actual design tooling (Figma workflows, design system docs, UI/UX review).
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
Before first use, verify:
|
|
24
|
+
|
|
25
|
+
1. **Brain configured** - For thought doc drafting
|
|
26
|
+
2. **Codex configured** - For PRD context and publishing
|
|
27
|
+
3. **gh CLI** - For creating PRs
|
|
28
|
+
|
|
29
|
+
## Usage
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
# Core Authoring (v1)
|
|
33
|
+
/tech-design start --from codex:{project} # Create thought doc, pull PRD/DESIGN context
|
|
34
|
+
/tech-design draft [section] # Auto-generate from PRD + codebase research
|
|
35
|
+
/tech-design think [topic] # Guided exploration, stress-test ideas
|
|
36
|
+
/tech-design gaps # Checklist of missing/empty sections
|
|
37
|
+
/tech-design publish # Generate roll-up + thought doc, open PR to codex
|
|
38
|
+
|
|
39
|
+
# Self-Review & Interaction (v2 - not yet implemented)
|
|
40
|
+
# /tech-design critic [persona] # Multi-persona review with severity scoring
|
|
41
|
+
# /tech-design respond {question} # Author tool: search thought doc to draft reply
|
|
42
|
+
# /tech-design ask {question} # Reviewer tool: search both docs to answer questions
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Configuration
|
|
46
|
+
|
|
47
|
+
Tech-design has no configuration of its own. It delegates to:
|
|
48
|
+
|
|
49
|
+
- **Brain skill** - Thought doc location (`brain_dir`, `inbox_folder`)
|
|
50
|
+
- **Codex skill** - Repository location (`codex_repo`)
|
|
51
|
+
|
|
52
|
+
## Behavior
|
|
53
|
+
|
|
54
|
+
Refer to the tech-design skill for:
|
|
55
|
+
|
|
56
|
+
- **Starting**: How to create thought doc from codex context
|
|
57
|
+
- **Drafting**: Research-first, structure-second content generation
|
|
58
|
+
- **Thinking**: Guided exploration to stress-test ideas
|
|
59
|
+
- **Gap Analysis**: What sections are missing or empty
|
|
60
|
+
- **Publishing**: Generate clean roll-up and create PR
|
|
61
|
+
|
|
62
|
+
The skill's `references/` folder contains detailed procedures for each workflow.
|
|
63
|
+
|
|
64
|
+
## Two-Document Approach
|
|
65
|
+
|
|
66
|
+
| Document | Purpose | Location |
|
|
67
|
+
| --------------- | --------------------------------------- | ------------- |
|
|
68
|
+
| **Thought doc** | Messy iteration, @mentions, exploration | Brain |
|
|
69
|
+
| **Roll-up** | Clean, reviewable, decision-focused | Codex project |
|
|
70
|
+
|
|
71
|
+
Both documents published to codex on `/tech-design publish` for full transparency.
|
|
72
|
+
|
|
73
|
+
## Examples
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
# Start a new tech design from codex project context
|
|
77
|
+
/tech-design start --from codex:transaction-templates
|
|
78
|
+
|
|
79
|
+
# Draft the entire doc from PRD and codebase research
|
|
80
|
+
/tech-design draft
|
|
81
|
+
|
|
82
|
+
# Explore a specific idea before committing to it
|
|
83
|
+
/tech-design think "Should we use events or polling for status updates?"
|
|
84
|
+
|
|
85
|
+
# Draft just the rollout section
|
|
86
|
+
/tech-design draft rollout
|
|
87
|
+
|
|
88
|
+
# See what's missing
|
|
89
|
+
/tech-design gaps
|
|
90
|
+
|
|
91
|
+
# Publish to codex when ready for review
|
|
92
|
+
/tech-design publish
|
|
93
|
+
```
|
|
@@ -0,0 +1,218 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: droid-tech-design
|
|
3
|
+
description: "Technical design authoring with three-document approach - research doc (codebase discoveries), thought doc (design iteration), and roll-up (clean summary). Use when writing tech designs, drafting sections, exploring architectural ideas, or publishing to codex. User prompts like 'start tech design for X', 'draft the rollout section', 'let's think through the API design', 'publish this to codex'."
|
|
4
|
+
globs: []
|
|
5
|
+
alwaysApply: false
|
|
6
|
+
allowed-tools:
|
|
7
|
+
[Read, Write, Edit, Glob, Grep, Bash(gh:*), Bash(git:*), Bash(mkdir:*), Task]
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Tech Design Skill
|
|
11
|
+
|
|
12
|
+
> Tech designs are where architectural decisions get made. Make them AI-friendly.
|
|
13
|
+
|
|
14
|
+
Technical design authoring for engineers using a three-document approach: research doc captures codebase discoveries, thought doc for design iteration, roll-up for reviewers. Markdown in GitHub, version-controlled, PR-reviewed.
|
|
15
|
+
|
|
16
|
+
## Why This Matters
|
|
17
|
+
|
|
18
|
+
Tech designs are often:
|
|
19
|
+
|
|
20
|
+
- Written in Confluence (slow, disconnected from code)
|
|
21
|
+
- Missing key sections (no template enforcement)
|
|
22
|
+
- Hard to iterate on (not AI-friendly)
|
|
23
|
+
- Siloed (reviewer can't see the author's thinking)
|
|
24
|
+
- Re-discovering the same patterns every time
|
|
25
|
+
|
|
26
|
+
The `/tech-design` skill brings tech design authoring into the same AI-augmented workflow engineers already use for coding, with persistent codebase knowledge.
|
|
27
|
+
|
|
28
|
+
## Prerequisites
|
|
29
|
+
|
|
30
|
+
Before using tech-design, verify:
|
|
31
|
+
|
|
32
|
+
1. **Brain skill configured:** Check if `~/.droid/skills/brain/overrides.yaml` exists
|
|
33
|
+
2. **Codex skill configured:** Check if `~/.droid/skills/codex/overrides.yaml` exists
|
|
34
|
+
3. **gh CLI:** Required for PR workflows
|
|
35
|
+
|
|
36
|
+
If prerequisites fail, guide user to configure:
|
|
37
|
+
|
|
38
|
+
- Brain missing: Direct to `/brain` command to set up brain directory
|
|
39
|
+
- Codex missing: Direct to `/codex` command to set up codex repository
|
|
40
|
+
- gh missing: `brew install gh && gh auth login`
|
|
41
|
+
|
|
42
|
+
## Configuration
|
|
43
|
+
|
|
44
|
+
Tech-design has no configuration of its own. It delegates to:
|
|
45
|
+
|
|
46
|
+
- **Brain skill** for research + thought doc location (`brain_dir`, `inbox_folder`)
|
|
47
|
+
- **Codex skill** for repository location (`codex_repo`)
|
|
48
|
+
|
|
49
|
+
## Three-Document Approach
|
|
50
|
+
|
|
51
|
+
| Document | Created When | Purpose | Location | Audience |
|
|
52
|
+
| --------------- | ------------ | ----------------------------------------------- | ------------- | ----------- |
|
|
53
|
+
| **Research** | `/start` | Deep dive: codex project + codebase discoveries | Brain | Author + AI |
|
|
54
|
+
| **Thought doc** | `/start` | Design iteration: decisions, @mentions, drafts | Brain | Author + AI |
|
|
55
|
+
| **Roll-up** | `/publish` | Clean summary: decisions only, reviewable | Codex project | Reviewers |
|
|
56
|
+
|
|
57
|
+
**Why three documents?**
|
|
58
|
+
|
|
59
|
+
1. **Research doc** = Persistent memory of codebase exploration
|
|
60
|
+
- Project-specific patterns discovered
|
|
61
|
+
- Existing implementations found
|
|
62
|
+
- Dependencies identified
|
|
63
|
+
- Stack/framework details
|
|
64
|
+
- Lives across sessions, not just context window
|
|
65
|
+
|
|
66
|
+
2. **Thought doc** = Design workspace
|
|
67
|
+
- References research doc for context
|
|
68
|
+
- Focuses on architectural decisions
|
|
69
|
+
- Iterates with `@droid`/`@user` comments
|
|
70
|
+
- Captures the "why" behind choices
|
|
71
|
+
|
|
72
|
+
3. **Roll-up** = Reviewer artifact
|
|
73
|
+
- Synthesized from thought doc
|
|
74
|
+
- Decision-focused, no exploration noise
|
|
75
|
+
- Ready for PR review
|
|
76
|
+
|
|
77
|
+
**Philosophy:** Research captures "what exists", thought doc explores "what we'll build", roll-up communicates "what we decided".
|
|
78
|
+
|
|
79
|
+
Both thought doc and roll-up are published to codex. Research doc stays in brain as project-specific knowledge base.
|
|
80
|
+
|
|
81
|
+
## Commands
|
|
82
|
+
|
|
83
|
+
| Command | Action | Status |
|
|
84
|
+
| ------------------------------------------- | -------------------------------------------------------- | ------ |
|
|
85
|
+
| `/tech-design start --from codex:{project}` | Create research + thought docs, pull PRD/DESIGN context | v1 |
|
|
86
|
+
| `/tech-design draft [section]` | Auto-generate from research doc + codebase exploration | v1 |
|
|
87
|
+
| `/tech-design think [topic]` | Guided exploration, updates research doc with findings | v1 |
|
|
88
|
+
| `/tech-design gaps` | Checklist of missing/empty sections | v1 |
|
|
89
|
+
| `/tech-design publish` | Generate roll-up, publish thought doc + roll-up to codex | v1 |
|
|
90
|
+
| `/tech-design critic [persona]` | Multi-persona review with severity scoring | v2 |
|
|
91
|
+
| `/tech-design respond {question}` | Author tool: search thought doc to draft reply | v2 |
|
|
92
|
+
| `/tech-design ask {question}` | Reviewer tool: search both docs to answer questions | v2 |
|
|
93
|
+
|
|
94
|
+
## Conversational Skill Matching
|
|
95
|
+
|
|
96
|
+
Commands are explicit entry points, but most usage will be natural conversation. Match these patterns:
|
|
97
|
+
|
|
98
|
+
| User says | Interpret as |
|
|
99
|
+
| -------------------------------------- | ---------------------------------------------------- |
|
|
100
|
+
| "Let's draft the rollout section" | `/draft rollout` - draft that section with research |
|
|
101
|
+
| "Can you write up the data model?" | `/draft data-model` - draft Data Model section |
|
|
102
|
+
| "I'm thinking about using events here" | `/think` - explore first, stress-test the idea |
|
|
103
|
+
| "Write that up" | After `/think`, transition to `/draft` for that idea |
|
|
104
|
+
| "What's missing?" | `/gaps` - show checklist of empty sections |
|
|
105
|
+
| "Let's think through the API" | `/think api` - guided exploration of API design |
|
|
106
|
+
|
|
107
|
+
## Starting a Tech Design
|
|
108
|
+
|
|
109
|
+
**Trigger:** `/tech-design start --from codex:{project}` or user wants to start a new tech design
|
|
110
|
+
|
|
111
|
+
**TLDR:** Create research + thought docs in brain, pull PRD/DESIGN context from codex, perform deep codebase dive, set as active.
|
|
112
|
+
|
|
113
|
+
**Full procedure:** See `references/start.md` for detailed implementation steps, error handling, and examples.
|
|
114
|
+
|
|
115
|
+
## Drafting Content
|
|
116
|
+
|
|
117
|
+
**Trigger:** `/tech-design draft [section]` or user wants to generate content
|
|
118
|
+
|
|
119
|
+
**TLDR:** Research doc first, then draft. Use research doc as knowledge base. Explore codebase if needed, update research doc with findings.
|
|
120
|
+
|
|
121
|
+
**Full procedure:** See `references/draft.md` for research strategies, section-specific guidance, and examples.
|
|
122
|
+
|
|
123
|
+
## Thinking Through Ideas
|
|
124
|
+
|
|
125
|
+
**Trigger:** `/tech-design think [topic]` or user wants to explore an idea
|
|
126
|
+
|
|
127
|
+
**TLDR:** Think = explore/stress-test; Draft = write to doc. Updates research doc with findings. Often flows: think → decide → draft.
|
|
128
|
+
|
|
129
|
+
**Full procedure:** See `references/think.md` for questioning strategies, directed vs freeform modes, and examples.
|
|
130
|
+
|
|
131
|
+
**Cross-platform approach:** Use prose-based questioning (works on OpenCode + Claude Code). Don't rely on interactive prompts.
|
|
132
|
+
|
|
133
|
+
## Gap Analysis
|
|
134
|
+
|
|
135
|
+
**Trigger:** `/tech-design gaps` or user asks "what's missing?"
|
|
136
|
+
|
|
137
|
+
**TLDR:** Show checklist of sections that are empty or missing. Offer `/think` for each.
|
|
138
|
+
|
|
139
|
+
**Full procedure:** See `references/gaps.md` for criticality logic, PRD-based inference, and examples.
|
|
140
|
+
|
|
141
|
+
## Publishing to Codex
|
|
142
|
+
|
|
143
|
+
**Trigger:** `/tech-design publish` or user wants to create PR for review
|
|
144
|
+
|
|
145
|
+
**TLDR:** Generate clean roll-up from thought doc, publish thought doc + roll-up to codex (research doc stays in brain).
|
|
146
|
+
|
|
147
|
+
**Full procedure:** See `references/publish.md` for roll-up generation, git workflow, quality checklist, and examples.
|
|
148
|
+
|
|
149
|
+
## Active Doc Tracking
|
|
150
|
+
|
|
151
|
+
Leverage brain's active doc tracking:
|
|
152
|
+
|
|
153
|
+
- When `/tech-design start` creates research + thought docs, thought doc becomes active
|
|
154
|
+
- Subsequent commands operate on active thought doc without specifying path
|
|
155
|
+
- Research doc is referenced by path when needed (stays as reference knowledge)
|
|
156
|
+
- User can also use `/brain` or `/scratchpad` to work on the thought doc
|
|
157
|
+
|
|
158
|
+
**Integration nudge:** Always remind users they can use brain commands:
|
|
159
|
+
|
|
160
|
+
- "You can add notes with `/brain add` or check comments with `/brain check`"
|
|
161
|
+
|
|
162
|
+
## Template Philosophy
|
|
163
|
+
|
|
164
|
+
**Research doc:** Codebase discovery log - captures patterns, implementations, stack details. Project-specific knowledge base.
|
|
165
|
+
|
|
166
|
+
**Thought doc:** Start minimal (3 sections), grow as needed:
|
|
167
|
+
|
|
168
|
+
- **Background** - Why we're doing this
|
|
169
|
+
- **Proposal** - What we're building
|
|
170
|
+
- **Open Questions** - What we don't know yet
|
|
171
|
+
|
|
172
|
+
Use `/gaps` to surface what's missing. Don't overwhelm at the start.
|
|
173
|
+
|
|
174
|
+
**Roll-up:** Clean summary for reviewers - decisions only, no exploration noise.
|
|
175
|
+
|
|
176
|
+
## Related Skills
|
|
177
|
+
|
|
178
|
+
- **Brain** - Thought doc drafting location, active doc tracking, @mention comments
|
|
179
|
+
- **Codex** - Context input (PRD/DESIGN), output location (TECH-DESIGN.md), PR creation
|
|
180
|
+
- **Project** - Personal working memory (different from shared codex knowledge)
|
|
181
|
+
|
|
182
|
+
## V2 Features (Not Yet Implemented)
|
|
183
|
+
|
|
184
|
+
The following features are planned for v2 but not yet available:
|
|
185
|
+
|
|
186
|
+
### Critic Personas
|
|
187
|
+
|
|
188
|
+
Run thought doc through multiple personas via parallel sub-agents:
|
|
189
|
+
|
|
190
|
+
| Persona | Focus |
|
|
191
|
+
| ----------------- | ----------------------------------------- |
|
|
192
|
+
| Security | Input validation, auth, rate limiting |
|
|
193
|
+
| Ops/SRE | Monitoring, alerting, runbooks |
|
|
194
|
+
| Junior Engineer | Clarity, documentation, "why X over Y?" |
|
|
195
|
+
| Product Owner | Does this solve the user problem? |
|
|
196
|
+
| Future Maintainer | Will someone understand this in 6 months? |
|
|
197
|
+
|
|
198
|
+
Output with severity scoring:
|
|
199
|
+
|
|
200
|
+
```
|
|
201
|
+
🔴 Security: No input validation mentioned for user-provided templates
|
|
202
|
+
🔴 Ops: Missing monitoring/alerting strategy
|
|
203
|
+
🟡 Future Maintainer: Decision rationale for X over Y is thin
|
|
204
|
+
🟢 Product: Aligns well with PRD requirements
|
|
205
|
+
🟢 Junior: Implementation plan is clear
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
### Interaction Tools
|
|
209
|
+
|
|
210
|
+
- `/tech-design respond {question}` - Author tool: search thought doc to draft reply to reviewer questions
|
|
211
|
+
- `/tech-design ask {question}` - Reviewer tool: search both docs to answer questions
|
|
212
|
+
|
|
213
|
+
## Notes
|
|
214
|
+
|
|
215
|
+
- Only create thought docs when user explicitly starts a tech design (don't be proactive)
|
|
216
|
+
- Always check for existing thought doc before creating new one
|
|
217
|
+
- Respect user's draft location preference (don't hardcode paths)
|
|
218
|
+
- If codex project missing: warn but continue (common during early adoption)
|