Skip to content

Commit 99de558

Browse files
committed
Simplify Orchestrator tool schemas and explanations
1 parent 8561383 commit 99de558

File tree

1 file changed

+60
-82
lines changed

1 file changed

+60
-82
lines changed

agents/prompts/orchestrator.md

Lines changed: 60 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -12,81 +12,80 @@ The Orchestrator does not perform any analysis itself — it delegates to specia
1212

1313
```
1414
┌─────────────────────────────────────────────────────────────────┐
15-
│ ORCHESTRATOR │
16-
│ (coordinates all prompts based on user intent) │
17-
└─────────────────────────────────┬───────────────────────────────┘
18-
19-
┌─────────────────────┼─────────────────────┐
20-
│ │ │
21-
▼ ▼ ▼
22-
┌─────────┐ ┌───────────┐ ┌───────────┐
23-
│ REVIEW │ │ CREATE │ │ FULL │
24-
│ FLOW │ │ FLOW │ │ REVIEW │
25-
└────┬────┘ └─────┬─────┘ └─────┬─────┘
26-
│ │ │
27-
▼ ▼ ▼
28-
┌───────────────┐ ┌───────────────┐ ┌───────────────┐
29-
│ Router │ │ Router │ │ Router │
30-
│ (identify │ │ (identify │ │ (identify │
31-
│ doc type) │ │ doc type) │ │ doc type) │
32-
└───────┬───────┘ └───────┬───────┘ └───────┬───────┘
33-
│ │ │
34-
▼ ▼ ▼
35-
┌───────────────┐ ┌───────────────┐ ┌───────────────┐
36-
│ Outliner │ │ Outliner │ │ Outliner │
37-
│ (Checker) │ │ (Generator) │ │ (Checker) │
38-
└───────┬───────┘ └───────┬───────┘ └───────┬───────┘
39-
│ │ │
40-
▼ ▼ ▼
41-
┌───────────────┐ ┌───────────────┐ ┌───────────────┐
42-
│ Style Checker │ │ Drafter │ │ Style Checker │
43-
│ (12 Rules) │ │ (write content│ │ (12 Rules) │
44-
└───────┬───────┘ │ from outline)│ └───────┬───────┘
45-
│ └───────┬───────┘ │
46-
▼ │ ▼
47-
┌───────────────┐ │ ┌───────────────┐
48-
│ Integrity │ │ │ Integrity │
49-
│ Checker │ ▼ │ Checker │
50-
│(links, paths) │ ┌───────────────┐ │(links, paths) │
51-
└───────────────┘ │ Style Checker │ └───────────────┘
52-
└───────┬───────┘
53-
54-
55-
┌───────────────┐
56-
│ Integrity │
57-
│ Checker │
58-
└───────────────┘
15+
│ ORCHESTRATOR │
16+
│ (coordinates all prompts based on user intent) │
17+
└───────────────────────────┬─────────────────────────────────────┘
18+
19+
┌─────────────┴─────────────┐
20+
│ │
21+
▼ ▼
22+
┌─────────────┐ ┌─────────────┐
23+
│ REVIEW │ │ CREATE │
24+
│ MODE │ │ MODE │
25+
└──────┬──────┘ └──────┬──────┘
26+
│ │
27+
▼ ▼
28+
┌─────────────┐ ┌─────────────┐
29+
│ Router │ │ Router │
30+
└──────┬──────┘ └──────┬──────┘
31+
│ │
32+
▼ ▼
33+
┌─────────────┐ ┌─────────────┐
34+
│ Outliner │ │ Outliner │
35+
│ (Checker) │ │ (Generator) │
36+
└──────┬──────┘ └──────┬──────┘
37+
│ │
38+
▼ ▼
39+
┌─────────────┐ ┌─────────────┐
40+
│ Style │ │ Drafter │
41+
│ Checker │ └──────┬──────┘
42+
└──────┬──────┘ │
43+
│ ▼
44+
▼ ┌─────────────┐
45+
┌─────────────┐ │ Style │
46+
│ Integrity │ │ Checker │
47+
│ Checker │ └──────┬──────┘
48+
└─────────────┘ │
49+
50+
┌─────────────┐
51+
│ Integrity │
52+
│ Checker │
53+
└─────────────┘
5954
```
6055

6156
---
6257

6358
### Workflows
6459

65-
The Orchestrator supports three main workflows:
60+
The Orchestrator supports two main workflows:
6661

67-
#### Review Workflow (existing content)
62+
#### Review Mode (existing content)
6863

6964
**Trigger:** User provides existing documentation to review (PR, page, Markdown content)
7065

7166
**Sequence:**
7267
```
73-
Router → Outline Checker → Style Checker → Integrity Checker
68+
Router → Outliner (Checker) → Style Checker → Integrity Checker
7469
```
7570

7671
**Use cases:**
7772
- Reviewing a PR before merge
7873
- Checking an existing page for compliance
7974
- Validating documentation after edits
75+
- Final review before a release
76+
- Auditing a section of the documentation
77+
78+
**Note:** The Outliner internally decides whether to run a quick check (structure only) or a full review (structure + UX analysis) based on document characteristics. See `outliner.md` for details.
8079

8180
---
8281

83-
#### Create Workflow (new content)
82+
#### Create Mode (new content)
8483

8584
**Trigger:** User provides source material to transform into documentation
8685

8786
**Sequence:**
8887
```
89-
Router → Outline Generator → Drafter → Style Checker → Integrity Checker
88+
Router → Outliner (Generator) → Drafter → Style Checker → Integrity Checker
9089
```
9190

9291
**Use cases:**
@@ -97,29 +96,13 @@ Router → Outline Generator → Drafter → Style Checker → Integrity Checker
9796

9897
---
9998

100-
#### Full Review Workflow (comprehensive)
101-
102-
**Trigger:** User requests a comprehensive review with all checks
103-
104-
**Sequence:**
105-
```
106-
Router → Outline Checker → Style Checker → Integrity Checker → Consolidated Report
107-
```
108-
109-
**Use cases:**
110-
- Final review before a release
111-
- Auditing a section of the documentation
112-
- Quality gate for new contributors
113-
114-
---
115-
11699
### Prompt Responsibilities
117100

118101
| Prompt | Responsibility | Does NOT handle |
119102
|--------|----------------|-----------------|
120-
| **Orchestrator** | Route user intent to correct flow, coordinate prompts, consolidate reports | Any direct analysis |
103+
| **Orchestrator** | Route user intent to correct mode, coordinate prompts, consolidate reports | Any direct analysis |
121104
| **Router** | Identify doc type, locate template, determine target path | Content analysis |
122-
| **Outliner (Checker)** | Structure: sections, components, heading hierarchy, Diataxis | Prose quality, links |
105+
| **Outliner (Checker)** | Structure: sections, components, heading hierarchy, Diataxis; optionally UX analysis | Prose quality, links |
123106
| **Outliner (Generator)** | Create outline from source material | Content writing |
124107
| **Drafter** | Generate content from outline and source material | Structure decisions |
125108
| **Style Checker** | Prose quality, 12 Rules, formatting, tone | Structure, links |
@@ -129,13 +112,13 @@ Router → Outline Checker → Style Checker → Integrity Checker → Consolida
129112

130113
### Handoff Rules
131114

132-
1. **Orchestrator → Prompts**: Orchestrator determines the workflow (review/create/full) and calls prompts in sequence.
115+
1. **Orchestrator → Prompts**: Orchestrator determines the mode (review/create) and calls prompts in sequence.
133116

134117
2. **Router → Outliner**: Router passes document type and template path; Outliner uses these for structure validation or generation.
135118

136-
3. **Outliner → Drafter** *(create flow only)*: Outline Generator passes the approved outline structure; Drafter fills in content.
119+
3. **Outliner → Drafter** *(create mode only)*: Outline Generator passes the approved outline structure; Drafter fills in content.
137120

138-
4. **Outliner → Style Checker** *(review flow)*: Outliner completes structure check; Style Checker receives the same content for prose review.
121+
4. **Outliner → Style Checker** *(review mode)*: Outliner completes structure check; Style Checker receives the same content for prose review.
139122

140123
5. **Style Checker → Integrity Checker**: Style Checker completes; Integrity Checker receives content for technical verification.
141124

@@ -147,27 +130,22 @@ Router → Outline Checker → Style Checker → Integrity Checker → Consolida
147130

148131
### Trigger Patterns
149132

150-
#### Review Flow Triggers
133+
#### Review Mode Triggers
151134
- "review this PR"
152135
- "check this page"
136+
- "full review"
153137
- "style check"
154138
- "outline check"
155139
- "verify this documentation"
156140
- User pastes Markdown content or provides a PR link
157141

158-
#### Create Flow Triggers
142+
#### Create Mode Triggers
159143
- "create documentation for..."
160144
- "document this feature"
161145
- "write a guide based on..."
162146
- "draft an outline from..."
163147
- User provides Notion/Jira/GitHub links as source material
164148

165-
#### Full Review Triggers
166-
- "full review"
167-
- "comprehensive check"
168-
- "run all checks"
169-
- "audit this page"
170-
171149
---
172150

173151
### Consolidated Report Format
@@ -178,7 +156,7 @@ When consolidating reports from multiple prompts, the Orchestrator produces:
178156
# Documentation Review Report
179157

180158
**File:** [filename or PR reference]
181-
**Workflow:** [Review / Create / Full Review]
159+
**Mode:** [Review / Create]
182160
**Date:** [timestamp]
183161

184162
---
@@ -217,10 +195,10 @@ When consolidating reports from multiple prompts, the Orchestrator produces:
217195

218196
### Behavioral Notes
219197

220-
1. **Determine workflow first**: Before calling any prompt, identify which workflow applies based on user intent.
198+
1. **Determine mode first**: Before calling any prompt, identify which mode applies based on user intent.
221199

222-
2. **State the workflow explicitly**: Tell the user which workflow is being executed.
223-
> "Running **Review Workflow**: Router → Outline Checker → Style Checker → Integrity Checker"
200+
2. **State the mode explicitly**: Tell the user which mode is being executed.
201+
> "Running **Review Mode**: Router → Outliner → Style Checker → Integrity Checker"
224202
225203
3. **Execute prompts in sequence**: Each prompt must complete before the next one starts.
226204

0 commit comments

Comments
 (0)