siesa-agents 2.1.43 → 2.1.44
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/bmad/bmm/workflows/5-documentation/README.md +234 -0
- package/bmad/bmm/workflows/5-documentation/create-user-guide/data/audience-types.csv +5 -0
- package/bmad/bmm/workflows/5-documentation/create-user-guide/data/diagram-types.csv +6 -0
- package/bmad/bmm/workflows/5-documentation/create-user-guide/data/section-structure.csv +10 -0
- package/bmad/bmm/workflows/5-documentation/create-user-guide/steps/step-01-init.md +313 -0
- package/bmad/bmm/workflows/5-documentation/create-user-guide/steps/step-01b-continue.md +268 -0
- package/bmad/bmm/workflows/5-documentation/create-user-guide/steps/step-02-seleccion-epicas.md +212 -0
- package/bmad/bmm/workflows/5-documentation/create-user-guide/steps/step-03-analisis-fuentes.md +308 -0
- package/bmad/bmm/workflows/5-documentation/create-user-guide/steps/step-04-elicitacion.md +332 -0
- package/bmad/bmm/workflows/5-documentation/create-user-guide/steps/step-05-generacion-espanol.md +608 -0
- package/bmad/bmm/workflows/5-documentation/create-user-guide/steps/step-06-traduccion-ingles.md +607 -0
- package/bmad/bmm/workflows/5-documentation/create-user-guide/steps/step-07-validacion-guardado.md +549 -0
- package/bmad/bmm/workflows/5-documentation/create-user-guide/templates/user-guide-template-en.md +50 -0
- package/bmad/bmm/workflows/5-documentation/create-user-guide/templates/user-guide-template-es.md +50 -0
- package/bmad/bmm/workflows/5-documentation/create-user-guide/workflow-plan-create-user-guide.md +949 -0
- package/bmad/bmm/workflows/5-documentation/create-user-guide/workflow.md +61 -0
- package/claude/commands/bmad/bmm/workflows/create-user-guide.md +5 -0
- package/gemini/commands/bmad-workflow-bmm-create-user-guide.toml +4 -0
- package/package.json +1 -1
package/bmad/bmm/workflows/5-documentation/create-user-guide/workflow-plan-create-user-guide.md
ADDED
|
@@ -0,0 +1,949 @@
|
|
|
1
|
+
---
|
|
2
|
+
stepsCompleted: [1, 2, 3, 4, 5, 6]
|
|
3
|
+
workflow_name: create-user-guide
|
|
4
|
+
workflow_type: document-building
|
|
5
|
+
target_module: bmm
|
|
6
|
+
target_phase: 5-documentation
|
|
7
|
+
plan_approved: true
|
|
8
|
+
output_format_approved: true
|
|
9
|
+
structure_design_approved: true
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Workflow Creation Plan: create-user-guide
|
|
13
|
+
|
|
14
|
+
## Initial Project Context
|
|
15
|
+
|
|
16
|
+
- **Workflow Name:** create-user-guide
|
|
17
|
+
- **Workflow Type:** document-building
|
|
18
|
+
- **Module:** bmm
|
|
19
|
+
- **Phase:** 5-documentation
|
|
20
|
+
- **Target Location:** `_bmad/bmm/workflows/5-documentation/create-user-guide/`
|
|
21
|
+
- **Created:** 2026-01-14
|
|
22
|
+
|
|
23
|
+
## Target Structure
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
_bmad/bmm/workflows/5-documentation/ ← FASE (documentation)
|
|
27
|
+
└── create-user-guide/ ← WORKFLOW FOLDER (todo dentro aquí)
|
|
28
|
+
├── workflow.md ← Main workflow file
|
|
29
|
+
├── steps/ ← Steps folder
|
|
30
|
+
│ ├── step-01-init.md
|
|
31
|
+
│ ├── step-02-seleccion-epicas.md
|
|
32
|
+
│ ├── step-03-analisis-fuentes.md
|
|
33
|
+
│ ├── step-04-elicitacion.md
|
|
34
|
+
│ ├── step-05-generacion-espanol.md
|
|
35
|
+
│ ├── step-06-traduccion-ingles.md
|
|
36
|
+
│ └── step-07-validacion-guardado.md
|
|
37
|
+
├── templates/ ← Templates folder
|
|
38
|
+
│ ├── user-guide-template-es.md
|
|
39
|
+
│ └── user-guide-template-en.md
|
|
40
|
+
└── data/ ← Data files folder
|
|
41
|
+
├── audience-types.csv
|
|
42
|
+
├── diagram-types.csv
|
|
43
|
+
└── section-structure.csv
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
**Important:** ALL workflow files (workflow.md, steps/, templates/, data/) go inside the `create-user-guide/` folder
|
|
47
|
+
|
|
48
|
+
## Problem Statement
|
|
49
|
+
|
|
50
|
+
Generar guías de usuario comprehensivas en español e inglés desde épicas y PRDs, con diagramas Mermaid y trazabilidad completa.
|
|
51
|
+
|
|
52
|
+
## Target Users
|
|
53
|
+
|
|
54
|
+
Product Managers, Technical Writers y equipos de documentación que necesitan crear guías de usuario a partir de artefactos existentes del proyecto (PRDs, épicas, stories, arquitectura).
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## WORKFLOW REQUIREMENTS (Gathered in Step 2)
|
|
59
|
+
|
|
60
|
+
### 1. Workflow Purpose and Scope
|
|
61
|
+
|
|
62
|
+
**Problem Solved:**
|
|
63
|
+
Generar guías de usuario comprehensivas en español e inglés desde épicas y PRDs, con diagramas Mermaid y trazabilidad completa. Elimina el dolor de crear documentación de usuario manualmente y asegura consistencia y completitud.
|
|
64
|
+
|
|
65
|
+
**Primary Users:**
|
|
66
|
+
- Product Managers
|
|
67
|
+
- Technical Writers
|
|
68
|
+
- Equipos de documentación
|
|
69
|
+
|
|
70
|
+
**Main Outcome:**
|
|
71
|
+
Guías de usuario bilingües (español/inglés) con:
|
|
72
|
+
- Diagramas Mermaid explicativos
|
|
73
|
+
- Screenshot placeholders con índice
|
|
74
|
+
- Source citations completas
|
|
75
|
+
- Estructura navegable
|
|
76
|
+
|
|
77
|
+
### 2. Workflow Type Classification
|
|
78
|
+
|
|
79
|
+
**Type:** Document Workflow
|
|
80
|
+
- Genera documentos como output principal ✓
|
|
81
|
+
- No es primariamente interactivo/coaching
|
|
82
|
+
- No es autónomo sin input humano
|
|
83
|
+
- No coordina otros workflows
|
|
84
|
+
|
|
85
|
+
### 3. Workflow Flow and Step Structure
|
|
86
|
+
|
|
87
|
+
**Step Count:** 7 steps
|
|
88
|
+
|
|
89
|
+
**Step Names:**
|
|
90
|
+
1. step-01-init
|
|
91
|
+
2. step-02-seleccion-epicas
|
|
92
|
+
3. step-03-analisis-fuentes
|
|
93
|
+
4. step-04-elicitacion
|
|
94
|
+
5. step-05-generacion-espanol
|
|
95
|
+
6. step-06-traduccion-ingles
|
|
96
|
+
7. step-07-validacion-guardado
|
|
97
|
+
|
|
98
|
+
**Flow Type:** Mayormente LINEAL con LOOP DE CORRECCIÓN opcional
|
|
99
|
+
- Linear progression: step-01 → step-02 → ... → step-07
|
|
100
|
+
- Correction loop: step-07 → step-05 (si se detectan problemas en validación)
|
|
101
|
+
|
|
102
|
+
**Decision Points:**
|
|
103
|
+
1. **step-01:** Decisión sobre guías existentes (crear/actualizar/reemplazar/cancelar)
|
|
104
|
+
2. **step-02:** Selección de épicas a incluir (todas/específicas/excluir)
|
|
105
|
+
3. **step-04:** Inclusión de sección troubleshooting (sí/no)
|
|
106
|
+
4. **step-07:** Validación OK → save / Issues → loop to step-05
|
|
107
|
+
|
|
108
|
+
**Optional Steps:** Ninguno (todos obligatorios)
|
|
109
|
+
|
|
110
|
+
**Optional Elements Within Steps:**
|
|
111
|
+
- Party Mode (disponible en todos los steps)
|
|
112
|
+
- Advanced options (disponible en todos los steps)
|
|
113
|
+
- Troubleshooting section (decidido en step-04)
|
|
114
|
+
|
|
115
|
+
**Logical Phases:**
|
|
116
|
+
Inicialización → Selección → Análisis → Elicitación → Generación → Validación
|
|
117
|
+
|
|
118
|
+
### 4. User Interaction Style
|
|
119
|
+
|
|
120
|
+
**Collaboration Level:** SEMI-COLABORATIVO (40% input usuario / 60% autónomo)
|
|
121
|
+
|
|
122
|
+
**Interaction Map:**
|
|
123
|
+
|
|
124
|
+
```
|
|
125
|
+
step-01 [🔴 ALTA COLABORACIÓN]
|
|
126
|
+
↓ Usuario decide: audiencia, acción sobre guías existentes
|
|
127
|
+
|
|
128
|
+
step-02 [🔴 ALTA COLABORACIÓN]
|
|
129
|
+
↓ Usuario selecciona: qué épicas incluir/excluir
|
|
130
|
+
|
|
131
|
+
step-03 [🟢 AUTÓNOMO]
|
|
132
|
+
↓ Agente lee y analiza artefactos (sin input usuario)
|
|
133
|
+
|
|
134
|
+
step-04 [🟡 COLABORACIÓN MEDIA]
|
|
135
|
+
↓ Usuario responde: exclusiones, nivel técnico, troubleshooting
|
|
136
|
+
|
|
137
|
+
step-05 [🟢 AUTÓNOMO con CHECKPOINTS]
|
|
138
|
+
↓ Agente genera contenido español (usuario puede revisar con [A])
|
|
139
|
+
|
|
140
|
+
step-06 [🟢 AUTÓNOMO con CHECKPOINTS]
|
|
141
|
+
↓ Agente traduce a inglés (usuario puede revisar con [A])
|
|
142
|
+
|
|
143
|
+
step-07 [🔴 ALTA COLABORACIÓN]
|
|
144
|
+
↓ Usuario valida y decide: guardar o corregir
|
|
145
|
+
|
|
146
|
+
Legend:
|
|
147
|
+
🔴 = Requiere input activo del usuario (DEBE pausar)
|
|
148
|
+
🟡 = Requiere input pero puede ser rápido
|
|
149
|
+
🟢 = Agente trabaja autónomamente (usuario puede supervisar)
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
**Critical Pause Points (MUST halt and wait for explicit confirmation):**
|
|
153
|
+
1. step-01: Después de presentar guías existentes
|
|
154
|
+
2. step-02: Después de presentar lista de épicas
|
|
155
|
+
3. step-04: Después de presentar funcionalidades identificadas
|
|
156
|
+
4. step-07: Después de self-check
|
|
157
|
+
|
|
158
|
+
**Workflow Adaptation to User Responses:**
|
|
159
|
+
|
|
160
|
+
**step-02 → posterior steps:**
|
|
161
|
+
- Si usuario excluye épicas → step-03 NO lee esas épicas
|
|
162
|
+
- Si usuario incluye solo 2 épicas → step-05 genera menos contenido
|
|
163
|
+
- Registro en frontmatter: `epics_selected: [1, 3, 5]`
|
|
164
|
+
|
|
165
|
+
**step-04 → step-05:**
|
|
166
|
+
- Si usuario dice "NO troubleshooting" → step-05 NO genera esa sección
|
|
167
|
+
- Si nivel técnico = "novice" → step-05 usa lenguaje más simple
|
|
168
|
+
- Si usuario menciona escenarios específicos → step-05 los incluye
|
|
169
|
+
|
|
170
|
+
**step-07 → loop:**
|
|
171
|
+
- Si validación falla → loop back to step-05 con correcciones
|
|
172
|
+
- Si validación OK → guardar y finalizar
|
|
173
|
+
|
|
174
|
+
### 5. Instruction Style (Intent-Based vs Prescriptive)
|
|
175
|
+
|
|
176
|
+
**Approach:** MIX (Prescriptive + Intent-Based)
|
|
177
|
+
|
|
178
|
+
| Step | Style | Justification |
|
|
179
|
+
|---------|--------------|------------------------------------------------------------------------------------|
|
|
180
|
+
| step-01 | PRESCRIPTIVE | Decisión crítica sobre guías existentes, debe ser consistente y claro |
|
|
181
|
+
| step-02 | PRESCRIPTIVE | Selección de épicas es crítica, necesita formato específico |
|
|
182
|
+
| step-03 | INTENT-BASED | Análisis flexible según artefactos disponibles |
|
|
183
|
+
| step-04 | INTENT-BASED | Elicitación conversacional, se adapta a contexto |
|
|
184
|
+
| step-05 | PRESCRIPTIVE | Generación con criterios estrictos (diagramas, citations, screenshots) |
|
|
185
|
+
| step-06 | PRESCRIPTIVE | Traducción debe mantener estructura idéntica, criterios claros |
|
|
186
|
+
| step-07 | PRESCRIPTIVE | Validación con checklist específica, decisión clara |
|
|
187
|
+
|
|
188
|
+
**Prescriptive Example (step-02):**
|
|
189
|
+
```
|
|
190
|
+
EXECUTION SEQUENCE:
|
|
191
|
+
1. Scan docs/prd/ for files matching pattern: epic-*.md
|
|
192
|
+
2. For each epic file found:
|
|
193
|
+
- Extract title from frontmatter or first H1
|
|
194
|
+
- Add to list: "Epic [number]: [title]"
|
|
195
|
+
3. Display to user in Spanish:
|
|
196
|
+
"He encontrado las siguientes épicas en el proyecto:
|
|
197
|
+
- Epic 1: [título]
|
|
198
|
+
- Epic 2: [título]
|
|
199
|
+
..."
|
|
200
|
+
4. Ask (exact text):
|
|
201
|
+
"¿Cuáles épicas desea incluir en la guía de usuario?
|
|
202
|
+
A) Todas las épicas
|
|
203
|
+
B) Épicas específicas (proporcionar números separados por comas)
|
|
204
|
+
C) Excluir épicas específicas (proporcionar números a excluir)"
|
|
205
|
+
5. Parse user response and store in frontmatter.epics_selected
|
|
206
|
+
6. HALT and show menu
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
**Intent-Based Example (step-04):**
|
|
210
|
+
```
|
|
211
|
+
STEP GOAL:
|
|
212
|
+
Elicit additional information from the user to refine the user guide scope and style.
|
|
213
|
+
|
|
214
|
+
EXECUTION APPROACH:
|
|
215
|
+
- Present the features identified from selected epics in a clear, organized manner
|
|
216
|
+
- Engage in conversational elicitation to understand:
|
|
217
|
+
· Which features should be excluded or de-prioritized
|
|
218
|
+
· Critical scenarios that need detailed documentation
|
|
219
|
+
· Technical competency level of target audience
|
|
220
|
+
· Known limitations or warnings users should be aware of
|
|
221
|
+
· Whether troubleshooting section is needed
|
|
222
|
+
- Adapt your questions based on user responses and project context
|
|
223
|
+
- Use Party Mode if deeper discussion is needed with PM/UX agents
|
|
224
|
+
- Record all preferences in frontmatter for use in generation steps
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
### 6. Input Requirements
|
|
228
|
+
|
|
229
|
+
**Validation Strategy (step-01):**
|
|
230
|
+
|
|
231
|
+
**1. Scan Locations (in priority order):**
|
|
232
|
+
|
|
233
|
+
A) BMAD 6 locations:
|
|
234
|
+
- `{planning_artifacts}/prd-*.md`
|
|
235
|
+
- `{planning_artifacts}/architecture-*.md`
|
|
236
|
+
- `{implementation_artifacts}/epic-*.md`
|
|
237
|
+
|
|
238
|
+
B) BMAD 4 locations (legacy):
|
|
239
|
+
- `docs/prd/*.md`
|
|
240
|
+
- `docs/architecture/*.md`
|
|
241
|
+
|
|
242
|
+
C) Custom locations:
|
|
243
|
+
- `{project_knowledge}/**/*.md`
|
|
244
|
+
|
|
245
|
+
**2. Validate Mandatory Files:**
|
|
246
|
+
|
|
247
|
+
✓ At least 1 PRD file found
|
|
248
|
+
✓ At least 1 epic-*.md file found
|
|
249
|
+
✓ (Optional) core-workflows.md or similar
|
|
250
|
+
|
|
251
|
+
**3. Strategy if Files Missing:**
|
|
252
|
+
|
|
253
|
+
**If NO PRD found:**
|
|
254
|
+
- WARN: "No se encontraron documentos PRD en las ubicaciones esperadas"
|
|
255
|
+
- ASK: "¿Desea especificar una ubicación alternativa o continuar sin PRD?"
|
|
256
|
+
- OPTIONS:
|
|
257
|
+
- A) Especificar path alternativo
|
|
258
|
+
- B) Continuar sin PRD (documentar solo desde épicas)
|
|
259
|
+
- C) Cancelar workflow
|
|
260
|
+
|
|
261
|
+
**If NO epics found:**
|
|
262
|
+
- CRITICAL ERROR: "No se encontraron épicas. Este workflow requiere épicas para documentar."
|
|
263
|
+
- SUGGEST: "Ejecute primero create-epics-and-stories o cree épicas manualmente"
|
|
264
|
+
- ABORT workflow
|
|
265
|
+
|
|
266
|
+
**If optional files missing:**
|
|
267
|
+
- INFO: "No se encontró [archivo]. La guía se generará sin esta información."
|
|
268
|
+
- CONTINUE normally
|
|
269
|
+
|
|
270
|
+
**Additional Useful Inputs (not mandatory):**
|
|
271
|
+
|
|
272
|
+
1. **Test suites:** `tests/**/*.test.{js,ts,py}` - Para documentar expected behaviors
|
|
273
|
+
2. **README.md** - Para contexto general y setup instructions
|
|
274
|
+
3. **CHANGELOG.md** - Para features recientes y versioning
|
|
275
|
+
4. **API documentation:** `docs/api/*.md` - Para guías de API consumers
|
|
276
|
+
5. **Existing screenshots:** `docs/images/**/*.png` - Para reutilizar en lugar de placeholders
|
|
277
|
+
6. **Previous user guides** - Para mantener consistencia de estilo
|
|
278
|
+
|
|
279
|
+
### 7. Output Specifications
|
|
280
|
+
|
|
281
|
+
**Primary Outputs:**
|
|
282
|
+
- `docs/user-guide/es/{audience}-guide.md` (Spanish version)
|
|
283
|
+
- `docs/user-guide/en/{audience}-guide.md` (English version)
|
|
284
|
+
- `docs/user-guide/index.md` (language selector)
|
|
285
|
+
|
|
286
|
+
**Output Timeline:**
|
|
287
|
+
|
|
288
|
+
| Step | Output Action |
|
|
289
|
+
|---------|--------------------------------------------------------------------------------|
|
|
290
|
+
| step-01 | Create outputFile with initial frontmatter |
|
|
291
|
+
| step-02 | Update frontmatter with selected epics |
|
|
292
|
+
| step-03 | Append "## Contexto del Proyecto" to Spanish outputFile |
|
|
293
|
+
| step-04 | Update frontmatter with user preferences |
|
|
294
|
+
| step-05 | Append all main sections (Spanish): Intro, Features, Workflows, FAQ, etc. |
|
|
295
|
+
| step-06 | Create English outputFile and generate translated content |
|
|
296
|
+
| step-07 | Validate, optionally correct, finalize; create/update index.md |
|
|
297
|
+
|
|
298
|
+
**Save Strategy:**
|
|
299
|
+
|
|
300
|
+
**Incremental Auto-Save:**
|
|
301
|
+
- Each step that modifies document → SAVES automatically
|
|
302
|
+
- Append-only pattern: document grows progressively
|
|
303
|
+
- User sees progress in real-time
|
|
304
|
+
|
|
305
|
+
**Final Confirmation (Manual):**
|
|
306
|
+
- step-07 requires explicit confirmation [S] Save before finalizing
|
|
307
|
+
- Allows correction loop without losing work
|
|
308
|
+
|
|
309
|
+
**Review Checkpoints:**
|
|
310
|
+
|
|
311
|
+
**Checkpoint 1 (step-05, after Spanish generation):**
|
|
312
|
+
- [A] Advanced - Review/edit specific section
|
|
313
|
+
- [P] Party Mode - Collaborative review with tech-writer/pm
|
|
314
|
+
- [C] Continue - Proceed to translation
|
|
315
|
+
|
|
316
|
+
**Checkpoint 2 (step-06, after translation):**
|
|
317
|
+
- [A] Advanced - Review/edit translation
|
|
318
|
+
- [P] Party Mode - Validate translation quality
|
|
319
|
+
- [C] Continue - Proceed to validation
|
|
320
|
+
|
|
321
|
+
**Checkpoint 3 (step-07, after validation):**
|
|
322
|
+
- [V] Validate - View self-check results
|
|
323
|
+
- [F] Fix Issues - Correct problems (loop to step-05)
|
|
324
|
+
- [S] Save - Save and finalize
|
|
325
|
+
|
|
326
|
+
**Screenshot Index:**
|
|
327
|
+
- Part of main document (not separate file)
|
|
328
|
+
- Generated in step-05 (Spanish) and step-06 (English)
|
|
329
|
+
- Location: Last section before Appendix
|
|
330
|
+
|
|
331
|
+
Format:
|
|
332
|
+
```markdown
|
|
333
|
+
## Screenshot Index / Índice de Capturas de Pantalla
|
|
334
|
+
|
|
335
|
+
| ID | Ubicación | Descripción | Estado |
|
|
336
|
+
|----|-----------|-------------|--------|
|
|
337
|
+
| FEATURE_AUTH_LOGIN | Sección 4.1 | Pantalla de login | Pendiente |
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
### 8. Success Criteria
|
|
341
|
+
|
|
342
|
+
**TOP 5 NON-NEGOTIABLE CRITERIA:**
|
|
343
|
+
|
|
344
|
+
**1. 📄 BILINGUAL OUTPUT COMPLETO**
|
|
345
|
+
- ✓ Both versions (es/ and en/) generated
|
|
346
|
+
- ✓ Identical structure in both languages
|
|
347
|
+
- ✓ Same number of sections and subsections
|
|
348
|
+
|
|
349
|
+
VALIDATION:
|
|
350
|
+
- Count headers in both files → must match
|
|
351
|
+
- Verify both files exist and are non-empty
|
|
352
|
+
|
|
353
|
+
**2. 🔗 SOURCE CITATIONS OBLIGATORIAS**
|
|
354
|
+
- ✓ Each feature has `[Source: Epic X Story Y]`
|
|
355
|
+
- ✓ Each workflow has source citation
|
|
356
|
+
- ✓ NO invented functionalities
|
|
357
|
+
|
|
358
|
+
VALIDATION:
|
|
359
|
+
- Regex search for `[Source: Epic \d+ Story \d+]`
|
|
360
|
+
- Count citations vs features → ratio >= 1.0
|
|
361
|
+
- Verify all epic numbers referenced actually exist
|
|
362
|
+
|
|
363
|
+
**3. 📊 DIAGRAMAS MERMAID COMPLETOS**
|
|
364
|
+
- ✓ Each feature has Mermaid diagram
|
|
365
|
+
- ✓ Each workflow has Mermaid diagram
|
|
366
|
+
- ✓ Diagrams localized (Spanish in es/, English in en/)
|
|
367
|
+
|
|
368
|
+
VALIDATION:
|
|
369
|
+
- Search for ```mermaid blocks
|
|
370
|
+
- Count diagrams >= count of features + workflows
|
|
371
|
+
- Verify diagram labels are in correct language
|
|
372
|
+
|
|
373
|
+
**4. 📸 SCREENSHOT PLACEHOLDERS PRESENTES**
|
|
374
|
+
- ✓ Screenshot placeholders with correct format
|
|
375
|
+
- ✓ Unique IDs in UPPER_SNAKE_CASE
|
|
376
|
+
- ✓ Complete Screenshot Index at end of document
|
|
377
|
+
|
|
378
|
+
VALIDATION:
|
|
379
|
+
- Regex search for `\[Screenshot: [A-Z_]+ - .*\]`
|
|
380
|
+
- Verify Screenshot Index table exists
|
|
381
|
+
- Cross-check: IDs in document match IDs in index
|
|
382
|
+
|
|
383
|
+
**5. ✅ SELF-CHECK PASADO**
|
|
384
|
+
- ✓ All selected epics are documented
|
|
385
|
+
- ✓ No empty or incomplete sections
|
|
386
|
+
- ✓ Complete frontmatter with metrics
|
|
387
|
+
|
|
388
|
+
VALIDATION:
|
|
389
|
+
- frontmatter.epics_selected all referenced in content
|
|
390
|
+
- No TODO or FIXME markers in final document
|
|
391
|
+
- frontmatter.completeness_score >= 90%
|
|
392
|
+
|
|
393
|
+
**Secondary Criteria (Important but don't block save):**
|
|
394
|
+
6. Troubleshooting section (if requested)
|
|
395
|
+
7. FAQ with at least 5 questions
|
|
396
|
+
8. Glossary with key terms defined
|
|
397
|
+
9. Language selector index.md created/updated
|
|
398
|
+
10. User confirmed language appropriate for audience
|
|
399
|
+
|
|
400
|
+
---
|
|
401
|
+
|
|
402
|
+
## TOOLS CONFIGURATION (Configured in Step 3)
|
|
403
|
+
|
|
404
|
+
### Core BMAD Tools
|
|
405
|
+
|
|
406
|
+
**Party-Mode:** ✅ INCLUDED
|
|
407
|
+
- **Integration Points:** Available as menu option [P] in all steps (01-07)
|
|
408
|
+
- **Purpose:** Collaborative discussion with other BMAD agents (PM, Analyst, UX Designer, Tech Writer)
|
|
409
|
+
- **Use Cases:**
|
|
410
|
+
- step-01: Discuss documentation strategy
|
|
411
|
+
- step-02: Prioritize epics with PM/Analyst
|
|
412
|
+
- step-03: Analyze context with Analyst/PM
|
|
413
|
+
- step-04: Discuss use cases with PM/UX
|
|
414
|
+
- step-05: Collaborative content review
|
|
415
|
+
- step-06: Translation quality validation
|
|
416
|
+
- step-07: Final review and validation
|
|
417
|
+
|
|
418
|
+
**Advanced Elicitation:** ✅ INCLUDED
|
|
419
|
+
- **Integration Points:** Available as menu option [A] in all steps (01-07)
|
|
420
|
+
- **Purpose:** Deep dive into specific aspects using Socratic questioning and counterfactual analysis
|
|
421
|
+
- **Use Cases:**
|
|
422
|
+
- step-01: Deep configuration and path exploration
|
|
423
|
+
- step-02: Detailed epic analysis before selection
|
|
424
|
+
- step-03: Deep dive into specific artifacts
|
|
425
|
+
- step-04: Profundizar en escenarios específicos
|
|
426
|
+
- step-05: Review/edit specific sections in detail
|
|
427
|
+
- step-06: Review/edit translation details
|
|
428
|
+
- step-07: Detailed validation and issue analysis
|
|
429
|
+
|
|
430
|
+
**Brainstorming:** ❌ NOT INCLUDED
|
|
431
|
+
- **Reason:** Not needed - workflow has clear structure and content is derived from existing artifacts (PRDs, epics), not creative ideation
|
|
432
|
+
|
|
433
|
+
### LLM Features
|
|
434
|
+
|
|
435
|
+
**File I/O:** ✅ INCLUDED (CRITICAL)
|
|
436
|
+
- **Operations Required:**
|
|
437
|
+
- **READ:** PRD files, epic files, architecture docs, workflow docs
|
|
438
|
+
- **WRITE:** Spanish user guide, English user guide, index.md
|
|
439
|
+
- **UPDATE:** Append content incrementally to guide documents
|
|
440
|
+
- **File Locations:**
|
|
441
|
+
- Input: `{planning_artifacts}/*.md`, `{implementation_artifacts}/epic-*.md`, `docs/prd/*.md`, `docs/architecture/*.md`
|
|
442
|
+
- Output: `docs/user-guide/es/{audience}-guide.md`, `docs/user-guide/en/{audience}-guide.md`, `docs/user-guide/index.md`
|
|
443
|
+
|
|
444
|
+
**Web-Browsing:** ❌ NOT INCLUDED
|
|
445
|
+
- **Reason:** All content is derived from existing project artifacts; no need for real-time web data
|
|
446
|
+
|
|
447
|
+
**Sub-Agents:** ❌ NOT INCLUDED
|
|
448
|
+
- **Reason:** Workflow steps are sequential and interdependent; parallel processing not needed
|
|
449
|
+
|
|
450
|
+
**Sub-Processes:** ❌ NOT INCLUDED
|
|
451
|
+
- **Reason:** Workflow is primarily sequential with manageable processing time; no long-running parallel operations needed
|
|
452
|
+
|
|
453
|
+
### Memory Systems
|
|
454
|
+
|
|
455
|
+
**Sidecar File:** ✅ INCLUDED
|
|
456
|
+
- **Purpose:** Enable workflow resumability between sessions
|
|
457
|
+
- **Use Cases:**
|
|
458
|
+
- User can pause after step-05 (Spanish generation) and resume later for translation
|
|
459
|
+
- User can pause during step-07 corrections and resume workflow
|
|
460
|
+
- Maintain progress for large projects with many epics
|
|
461
|
+
- **State Tracked:**
|
|
462
|
+
- Current step position
|
|
463
|
+
- Selected epics and user preferences
|
|
464
|
+
- Generated content progress
|
|
465
|
+
- Validation results
|
|
466
|
+
- **File Location:** `{bmb_creations_output_folder}/workflows/create-user-guide/.sidecar-create-user-guide.yaml`
|
|
467
|
+
|
|
468
|
+
**Vector Database:** ❌ NOT INCLUDED
|
|
469
|
+
- **Reason:** Not needed for v1; no requirement for semantic search across workflow history
|
|
470
|
+
|
|
471
|
+
### External Integrations
|
|
472
|
+
|
|
473
|
+
**Git Integration:** ❌ NOT INCLUDED
|
|
474
|
+
- **Reason:** User can commit generated guides manually; automatic commits not required for v1
|
|
475
|
+
|
|
476
|
+
**Context-7 / Playwright / Database Connectors:** ❌ NOT INCLUDED
|
|
477
|
+
- **Reason:** Not applicable to documentation generation workflow
|
|
478
|
+
|
|
479
|
+
### Installation Requirements
|
|
480
|
+
|
|
481
|
+
**Tools Requiring Installation:** NONE
|
|
482
|
+
- All selected tools (File I/O, Party-Mode, Advanced Elicitation, Sidecar File) are built into BMAD Core
|
|
483
|
+
- No external dependencies or installations required
|
|
484
|
+
|
|
485
|
+
**User Installation Preference:** N/A
|
|
486
|
+
- No installations needed
|
|
487
|
+
|
|
488
|
+
### Tools Configuration Summary
|
|
489
|
+
|
|
490
|
+
**✅ Included Tools (4):**
|
|
491
|
+
1. File I/O (LLM feature - critical)
|
|
492
|
+
2. Party-Mode (BMAD workflow)
|
|
493
|
+
3. Advanced Elicitation (BMAD workflow)
|
|
494
|
+
4. Sidecar File (Memory system)
|
|
495
|
+
|
|
496
|
+
**❌ Excluded Tools (6):**
|
|
497
|
+
1. Brainstorming
|
|
498
|
+
2. Web-Browsing
|
|
499
|
+
3. Sub-Agents
|
|
500
|
+
4. Sub-Processes
|
|
501
|
+
5. Git Integration
|
|
502
|
+
6. Vector Database
|
|
503
|
+
|
|
504
|
+
**Installation Requirements:** None - all tools are BMAD built-ins
|
|
505
|
+
|
|
506
|
+
---
|
|
507
|
+
|
|
508
|
+
## OUTPUT FORMAT DESIGN (Designed in Step 5)
|
|
509
|
+
|
|
510
|
+
### Format Type
|
|
511
|
+
|
|
512
|
+
**Selected Format:** STRUCTURED
|
|
513
|
+
|
|
514
|
+
- Document type: Technical Documentation (User Guide)
|
|
515
|
+
- File format: Markdown (.md)
|
|
516
|
+
- Frequency: Single document per audience (with bilingual versions)
|
|
517
|
+
- Consistency: Cross-document identical structure required
|
|
518
|
+
|
|
519
|
+
### Structure Specifications
|
|
520
|
+
|
|
521
|
+
**Required Sections (9 obligatory):**
|
|
522
|
+
|
|
523
|
+
1. **Frontmatter (YAML)** - Workflow metadata and tracking
|
|
524
|
+
2. **Introduction** - Product overview, target audience, guide usage
|
|
525
|
+
3. **Getting Started** - Prerequisites, setup, system access, interface overview
|
|
526
|
+
4. **Core Concepts** - Key terminology, main concepts, user roles
|
|
527
|
+
5. **Features and How to Use Them** - Feature descriptions with diagrams, screenshots, source citations
|
|
528
|
+
6. **Common Workflows** - Step-by-step workflows with diagrams and screenshots
|
|
529
|
+
7. **FAQ** - Frequently asked questions
|
|
530
|
+
8. **Glossary** - Terms and definitions
|
|
531
|
+
9. **Screenshot Index** - Consolidated table of all screenshot placeholders
|
|
532
|
+
|
|
533
|
+
**Optional Sections (2 conditional):**
|
|
534
|
+
|
|
535
|
+
10. **Troubleshooting** - Common issues and solutions (decided in step-04)
|
|
536
|
+
11. **Appendix** - Quick reference tables, keyboard shortcuts, additional resources (if relevant)
|
|
537
|
+
|
|
538
|
+
**Section Ordering Rules:**
|
|
539
|
+
|
|
540
|
+
- Sections 1-9: FIXED order (cannot be changed)
|
|
541
|
+
- Troubleshooting: Goes between FAQ and Glossary (if included)
|
|
542
|
+
- Appendix: Goes after Screenshot Index (if included)
|
|
543
|
+
|
|
544
|
+
### Cross-Document Consistency Requirements
|
|
545
|
+
|
|
546
|
+
**Bilingual Consistency (Spanish/English):**
|
|
547
|
+
|
|
548
|
+
1. **Identical Structure:**
|
|
549
|
+
- Spanish (es/) and English (en/) versions must have EXACTLY the same sections
|
|
550
|
+
- Same number of headers (H1, H2, H3, H4)
|
|
551
|
+
- Same number of Mermaid diagrams
|
|
552
|
+
- Same number of screenshot placeholders
|
|
553
|
+
|
|
554
|
+
2. **Non-Translatable Elements:**
|
|
555
|
+
- Source citations: `[Source: Epic X Story Y]` → remain unchanged
|
|
556
|
+
- Screenshot IDs: `FEATURE_AUTH_LOGIN` → remain unchanged
|
|
557
|
+
- Frontmatter keys → remain in English
|
|
558
|
+
|
|
559
|
+
3. **Localized Elements:**
|
|
560
|
+
- All textual content
|
|
561
|
+
- Mermaid diagram labels
|
|
562
|
+
- Screenshot descriptions
|
|
563
|
+
- Section headers
|
|
564
|
+
|
|
565
|
+
### Format Standards
|
|
566
|
+
|
|
567
|
+
**Header Format:**
|
|
568
|
+
|
|
569
|
+
```markdown
|
|
570
|
+
# [Product Name] User Guide ← H1 (main title only)
|
|
571
|
+
## Introduction ← H2 (main sections)
|
|
572
|
+
### What is [Product]? ← H3 (subsections)
|
|
573
|
+
#### Creating a New Credential ← H4 (specific procedures)
|
|
574
|
+
```
|
|
575
|
+
|
|
576
|
+
**Diagram Format:**
|
|
577
|
+
|
|
578
|
+
- **Syntax:** Mermaid code blocks
|
|
579
|
+
- **Location:** Immediately after feature/workflow description
|
|
580
|
+
- **Labels:** Localized according to document language
|
|
581
|
+
- **Allowed Types:** flowchart, sequenceDiagram, stateDiagram-v2, journey
|
|
582
|
+
|
|
583
|
+
**Screenshot Placeholder Format:**
|
|
584
|
+
|
|
585
|
+
```markdown
|
|
586
|
+
[Screenshot: IDENTIFIER - Description]
|
|
587
|
+
|
|
588
|
+
Where:
|
|
589
|
+
- IDENTIFIER = UPPER_SNAKE_CASE with prefix (FEATURE_, WORKFLOW_, UI_, ERROR_)
|
|
590
|
+
- Description = Specific in document language
|
|
591
|
+
```
|
|
592
|
+
|
|
593
|
+
**Source Citation Format:**
|
|
594
|
+
|
|
595
|
+
```markdown
|
|
596
|
+
[Source: Epic X Story Y]
|
|
597
|
+
[Source: Epic X Story Y, Epic Z Story W]
|
|
598
|
+
[Source: PRD - section-name]
|
|
599
|
+
```
|
|
600
|
+
|
|
601
|
+
### Frontmatter Structure (YAML)
|
|
602
|
+
|
|
603
|
+
```yaml
|
|
604
|
+
---
|
|
605
|
+
# Workflow state
|
|
606
|
+
stepsCompleted: []
|
|
607
|
+
currentStep: step-01-init
|
|
608
|
+
workflow_name: create-user-guide
|
|
609
|
+
workflow_version: 1.0.0
|
|
610
|
+
|
|
611
|
+
# Project context
|
|
612
|
+
project_name: ""
|
|
613
|
+
generated_date: ""
|
|
614
|
+
last_modified: ""
|
|
615
|
+
|
|
616
|
+
# Configuration
|
|
617
|
+
target_audience: "" # enduser / admin / api / mixed
|
|
618
|
+
output_language: "" # es / en
|
|
619
|
+
epics_selected: [] # [1, 3, 5]
|
|
620
|
+
epics_excluded: [] # [2, 4]
|
|
621
|
+
|
|
622
|
+
# Source artifacts discovered
|
|
623
|
+
source_artifacts:
|
|
624
|
+
prd_docs: []
|
|
625
|
+
epic_files: []
|
|
626
|
+
architecture_docs: []
|
|
627
|
+
workflow_docs: []
|
|
628
|
+
|
|
629
|
+
# Content tracking
|
|
630
|
+
features_documented: 0
|
|
631
|
+
workflows_documented: 0
|
|
632
|
+
diagrams_generated: 0
|
|
633
|
+
screenshot_placeholders: 0
|
|
634
|
+
|
|
635
|
+
# Quality metrics
|
|
636
|
+
source_citations_count: 0
|
|
637
|
+
completeness_score: 0
|
|
638
|
+
review_status: "draft" # draft / reviewed / approved
|
|
639
|
+
|
|
640
|
+
# User preferences
|
|
641
|
+
technical_level: "" # novice / intermediate / mixed
|
|
642
|
+
include_troubleshooting: false
|
|
643
|
+
additional_scenarios: []
|
|
644
|
+
|
|
645
|
+
# Bilingual output
|
|
646
|
+
spanish_version: "" # path to es/ file
|
|
647
|
+
english_version: "" # path to en/ file
|
|
648
|
+
translation_completed: false
|
|
649
|
+
---
|
|
650
|
+
```
|
|
651
|
+
|
|
652
|
+
### Template Information
|
|
653
|
+
|
|
654
|
+
**Templates to Create:**
|
|
655
|
+
|
|
656
|
+
1. **user-guide-template-es.md**
|
|
657
|
+
- Complete structure in Spanish
|
|
658
|
+
- Placeholders: `{{project_name}}`, `{{generated_date}}`, `{{audience}}`
|
|
659
|
+
- All sections with Spanish headers
|
|
660
|
+
- Location: `{targetWorkflowPath}/templates/user-guide-template-es.md`
|
|
661
|
+
|
|
662
|
+
2. **user-guide-template-en.md**
|
|
663
|
+
- Same structure as Spanish template
|
|
664
|
+
- All sections and headers in English
|
|
665
|
+
- Same placeholders
|
|
666
|
+
- Location: `{targetWorkflowPath}/templates/user-guide-template-en.md`
|
|
667
|
+
|
|
668
|
+
### Data Files (CSV)
|
|
669
|
+
|
|
670
|
+
**1. audience-types.csv**
|
|
671
|
+
|
|
672
|
+
Purpose: Define target audience types and filename patterns
|
|
673
|
+
|
|
674
|
+
```csv
|
|
675
|
+
audience_id,audience_name_es,audience_name_en,description_es,description_en,filename_prefix
|
|
676
|
+
enduser,Usuarios Finales,End Users,"Usuarios que interactúan con la aplicación","Users who interact with the application",enduser-guide
|
|
677
|
+
admin,Administradores,Administrators,"Usuarios que gestionan el sistema","Users who manage the system",admin-guide
|
|
678
|
+
api,Consumidores de API,API Consumers,"Desarrolladores que integran con el sistema","Developers who integrate with the system",api-guide
|
|
679
|
+
mixed,Audiencia Mixta,Mixed Audience,"Usuarios finales y administradores","End users and administrators",complete-guide
|
|
680
|
+
```
|
|
681
|
+
|
|
682
|
+
**2. diagram-types.csv**
|
|
683
|
+
|
|
684
|
+
Purpose: Define Mermaid diagram types for different content
|
|
685
|
+
|
|
686
|
+
```csv
|
|
687
|
+
content_type,diagram_type,mermaid_syntax,use_case_es,use_case_en
|
|
688
|
+
feature_overview,flowchart,"flowchart LR","Mostrar componentes y relaciones","Show components and relationships"
|
|
689
|
+
user_workflow,flowchart,"flowchart TD","Proceso paso a paso con decisiones","Step-by-step process with decisions"
|
|
690
|
+
sequential_process,sequenceDiagram,"sequenceDiagram","Interacciones usuario-sistema","User-system interactions"
|
|
691
|
+
state_changes,stateDiagram-v2,"stateDiagram-v2","Cambios de estado de datos","Data state changes"
|
|
692
|
+
user_journey,journey,"journey","Experiencia del usuario","User experience across touchpoints"
|
|
693
|
+
```
|
|
694
|
+
|
|
695
|
+
**3. section-structure.csv**
|
|
696
|
+
|
|
697
|
+
Purpose: Define section order and requirements
|
|
698
|
+
|
|
699
|
+
```csv
|
|
700
|
+
section_id,section_name_es,section_name_en,description,required
|
|
701
|
+
1,Introducción,Introduction,"What is the product, who is this guide for, how to use it",true
|
|
702
|
+
2,Primeros Pasos,Getting Started,"Prerequisites, setup, accessing system, interface overview",true
|
|
703
|
+
3,Conceptos Clave,Core Concepts,"Key terminology, main concepts, user roles",true
|
|
704
|
+
4,Funcionalidades,Features and How to Use Them,"Feature descriptions with diagrams and screenshots",true
|
|
705
|
+
5,Flujos de Trabajo,Common Workflows,"Step-by-step workflows with diagrams",true
|
|
706
|
+
6,Solución de Problemas,Troubleshooting,"Common issues and solutions",false
|
|
707
|
+
7,Preguntas Frecuentes,FAQ,"Frequently asked questions",true
|
|
708
|
+
8,Glosario,Glossary,"Terms and definitions",true
|
|
709
|
+
9,Índice de Capturas,Screenshot Index,"Table of all screenshot placeholders",true
|
|
710
|
+
```
|
|
711
|
+
|
|
712
|
+
### Special Considerations
|
|
713
|
+
|
|
714
|
+
**Validation Requirements:**
|
|
715
|
+
|
|
716
|
+
- Bilingual output must have identical structure (header count, diagram count, screenshot count)
|
|
717
|
+
- All features must have source citations
|
|
718
|
+
- All features and workflows must have Mermaid diagrams
|
|
719
|
+
- Screenshot Index must consolidate all placeholders
|
|
720
|
+
- Frontmatter completeness_score must be >= 90%
|
|
721
|
+
|
|
722
|
+
**Accessibility Requirements:**
|
|
723
|
+
|
|
724
|
+
- Clear header hierarchy (H1 → H2 → H3 → H4)
|
|
725
|
+
- Descriptive screenshot placeholders for screen readers
|
|
726
|
+
- Mermaid diagrams with clear labels
|
|
727
|
+
- Glossary for technical terms
|
|
728
|
+
|
|
729
|
+
**Quality Standards:**
|
|
730
|
+
|
|
731
|
+
- No TODO or FIXME markers in final output
|
|
732
|
+
- All source citations must reference existing epic/story files
|
|
733
|
+
- Diagrams must be valid Mermaid syntax
|
|
734
|
+
- Screenshot IDs must be unique and follow naming convention
|
|
735
|
+
|
|
736
|
+
---
|
|
737
|
+
|
|
738
|
+
## WORKFLOW STRUCTURE DESIGN (Designed in Step 6)
|
|
739
|
+
|
|
740
|
+
### Step Structure
|
|
741
|
+
|
|
742
|
+
**Total Steps:** 8 (including continuation support)
|
|
743
|
+
|
|
744
|
+
1. **step-01-init.md** - Initialization with continuation detection
|
|
745
|
+
2. **step-01b-continue.md** - Resume workflow from saved state
|
|
746
|
+
3. **step-02-seleccion-epicas.md** - Epic selection (PRESCRIPTIVE)
|
|
747
|
+
4. **step-03-analisis-fuentes.md** - Artifact analysis (INTENT-BASED)
|
|
748
|
+
5. **step-04-elicitacion.md** - Information elicitation (INTENT-BASED)
|
|
749
|
+
6. **step-05-generacion-espanol.md** - Spanish content generation (PRESCRIPTIVE)
|
|
750
|
+
7. **step-06-traduccion-ingles.md** - English translation (PRESCRIPTIVE)
|
|
751
|
+
8. **step-07-validacion-guardado.md** - Validation and save (PRESCRIPTIVE)
|
|
752
|
+
|
|
753
|
+
**Flow:** Linear with optional loop (step-07 → step-05 for corrections)
|
|
754
|
+
|
|
755
|
+
**Continuation Support:** YES (step-01b-continue.md for resumability)
|
|
756
|
+
|
|
757
|
+
### Interaction Patterns by Step
|
|
758
|
+
|
|
759
|
+
| Step | Collaboration Level | Menu Options | Pause Required |
|
|
760
|
+
|------|---------------------|--------------|----------------|
|
|
761
|
+
| 01 | 🔴 High | [A] [P] [C] | Yes - after audience selection |
|
|
762
|
+
| 01b | 🟡 Medium | [R] [M] [C] | Yes - review progress |
|
|
763
|
+
| 02 | 🔴 High | [A] [P] [R] [C] | Yes - after epic selection |
|
|
764
|
+
| 03 | 🟢 Autonomous | [A] [P] [R] [C] | No - autonomous work |
|
|
765
|
+
| 04 | 🟡 Medium | [A] [P] [C] | Yes - after elicitation |
|
|
766
|
+
| 05 | 🟢 Autonomous | [A] [P] [C] | No - checkpoints available |
|
|
767
|
+
| 06 | 🟢 Autonomous | [A] [P] [C] | No - checkpoints available |
|
|
768
|
+
| 07 | 🔴 High | [V] [F] [S] | Yes - after validation |
|
|
769
|
+
|
|
770
|
+
### Data Flow Map
|
|
771
|
+
|
|
772
|
+
```
|
|
773
|
+
step-01-init
|
|
774
|
+
├─ INPUT: config.yaml, existing guides scan
|
|
775
|
+
├─ OUTPUT → frontmatter: target_audience, output_language, generated_date
|
|
776
|
+
└─ CREATE: outputFile (es/[audience]-guide.md) with initial frontmatter
|
|
777
|
+
|
|
778
|
+
step-01b-continue (if resuming)
|
|
779
|
+
├─ INPUT: sidecar file (.sidecar-create-user-guide.yaml)
|
|
780
|
+
├─ OUTPUT: load previous state
|
|
781
|
+
└─ JUMP: to appropriate step based on stepsCompleted
|
|
782
|
+
|
|
783
|
+
step-02-seleccion-epicas
|
|
784
|
+
├─ INPUT: frontmatter from step-01
|
|
785
|
+
├─ PROCESS: scan epic-*.md files
|
|
786
|
+
└─ OUTPUT → frontmatter: epics_selected, epics_excluded, source_artifacts.epic_files
|
|
787
|
+
|
|
788
|
+
step-03-analisis-fuentes
|
|
789
|
+
├─ INPUT: frontmatter.epics_selected, PRD/architecture files
|
|
790
|
+
├─ PROCESS: read and analyze artifacts
|
|
791
|
+
├─ OUTPUT → frontmatter: source_artifacts (prd_docs, architecture_docs, workflow_docs)
|
|
792
|
+
└─ APPEND → outputFile: "## Contexto del Proyecto" section
|
|
793
|
+
|
|
794
|
+
step-04-elicitacion
|
|
795
|
+
├─ INPUT: frontmatter from step-03
|
|
796
|
+
├─ PROCESS: conversational elicitation
|
|
797
|
+
└─ OUTPUT → frontmatter: technical_level, include_troubleshooting, additional_scenarios
|
|
798
|
+
|
|
799
|
+
step-05-generacion-espanol
|
|
800
|
+
├─ INPUT: frontmatter (all data from steps 01-04), source_artifacts
|
|
801
|
+
├─ PROCESS: generate Spanish content with Mermaid diagrams, screenshots, citations
|
|
802
|
+
├─ APPEND → outputFile: all main sections (Introduction → Screenshot Index)
|
|
803
|
+
└─ OUTPUT → frontmatter: features_documented, workflows_documented, diagrams_generated,
|
|
804
|
+
screenshot_placeholders, source_citations_count
|
|
805
|
+
|
|
806
|
+
step-06-traduccion-ingles
|
|
807
|
+
├─ INPUT: outputFile (Spanish version), frontmatter
|
|
808
|
+
├─ PROCESS: translate maintaining identical structure
|
|
809
|
+
├─ CREATE: en/[audience]-guide.md
|
|
810
|
+
└─ OUTPUT → frontmatter: english_version, spanish_version, translation_completed
|
|
811
|
+
|
|
812
|
+
step-07-validacion-guardado
|
|
813
|
+
├─ INPUT: both output files (es/ and en/), frontmatter
|
|
814
|
+
├─ PROCESS: self-check validation (headers, diagrams, screenshots, citations)
|
|
815
|
+
├─ OUTPUT: validation report
|
|
816
|
+
├─ IF [S] Save: update frontmatter (review_status: "approved"), CREATE index.md, FINALIZE
|
|
817
|
+
└─ IF [F] Fix: LOOP → step-05 with corrections list
|
|
818
|
+
```
|
|
819
|
+
|
|
820
|
+
### State Persistence (Sidecar File)
|
|
821
|
+
|
|
822
|
+
**Location:** `_bmad-output/bmb-creations/workflows/create-user-guide/.sidecar-create-user-guide.yaml`
|
|
823
|
+
|
|
824
|
+
**Content Structure:**
|
|
825
|
+
```yaml
|
|
826
|
+
workflow_name: create-user-guide
|
|
827
|
+
current_step: step-05-generacion-espanol
|
|
828
|
+
steps_completed: [1, 2, 3, 4]
|
|
829
|
+
last_updated: "2026-01-14T15:30:00Z"
|
|
830
|
+
|
|
831
|
+
# Context restoration
|
|
832
|
+
target_audience: enduser
|
|
833
|
+
epics_selected: [1, 3, 5]
|
|
834
|
+
technical_level: intermediate
|
|
835
|
+
include_troubleshooting: true
|
|
836
|
+
|
|
837
|
+
# Output paths
|
|
838
|
+
spanish_output: "docs/user-guide/es/enduser-guide.md"
|
|
839
|
+
english_output: "docs/user-guide/en/enduser-guide.md"
|
|
840
|
+
|
|
841
|
+
# Progress
|
|
842
|
+
features_documented: 8
|
|
843
|
+
workflows_documented: 3
|
|
844
|
+
```
|
|
845
|
+
|
|
846
|
+
### File Structure Design
|
|
847
|
+
|
|
848
|
+
```
|
|
849
|
+
_bmad/bmm/workflows/5-documentation/create-user-guide/
|
|
850
|
+
├── workflow.md ← Main workflow configuration
|
|
851
|
+
│
|
|
852
|
+
├── steps/ ← Step files (8 total)
|
|
853
|
+
│ ├── step-01-init.md
|
|
854
|
+
│ ├── step-01b-continue.md
|
|
855
|
+
│ ├── step-02-seleccion-epicas.md
|
|
856
|
+
│ ├── step-03-analisis-fuentes.md
|
|
857
|
+
│ ├── step-04-elicitacion.md
|
|
858
|
+
│ ├── step-05-generacion-espanol.md
|
|
859
|
+
│ ├── step-06-traduccion-ingles.md
|
|
860
|
+
│ └── step-07-validacion-guardado.md
|
|
861
|
+
│
|
|
862
|
+
├── templates/ ← Template files (2 total)
|
|
863
|
+
│ ├── user-guide-template-es.md
|
|
864
|
+
│ └── user-guide-template-en.md
|
|
865
|
+
│
|
|
866
|
+
└── data/ ← CSV data files (3 total)
|
|
867
|
+
├── audience-types.csv ← 4 audience types
|
|
868
|
+
├── diagram-types.csv ← 5 diagram types
|
|
869
|
+
└── section-structure.csv ← 9 sections
|
|
870
|
+
```
|
|
871
|
+
|
|
872
|
+
### Path Variables (for step files)
|
|
873
|
+
|
|
874
|
+
```yaml
|
|
875
|
+
# Workflow paths
|
|
876
|
+
workflow_path: '{project-root}/_bmad/bmm/workflows/5-documentation/create-user-guide'
|
|
877
|
+
thisStepFile: '{workflow_path}/steps/step-[N]-[name].md'
|
|
878
|
+
nextStepFile: '{workflow_path}/steps/step-[N+1]-[name].md'
|
|
879
|
+
workflowFile: '{workflow_path}/workflow.md'
|
|
880
|
+
|
|
881
|
+
# Output files (created during execution)
|
|
882
|
+
outputFileSpanish: 'docs/user-guide/es/{audience}-guide.md'
|
|
883
|
+
outputFileEnglish: 'docs/user-guide/en/{audience}-guide.md'
|
|
884
|
+
indexFile: 'docs/user-guide/index.md'
|
|
885
|
+
|
|
886
|
+
# Templates
|
|
887
|
+
templateSpanish: '{workflow_path}/templates/user-guide-template-es.md'
|
|
888
|
+
templateEnglish: '{workflow_path}/templates/user-guide-template-en.md'
|
|
889
|
+
|
|
890
|
+
# Data files
|
|
891
|
+
audienceTypesData: '{workflow_path}/data/audience-types.csv'
|
|
892
|
+
diagramTypesData: '{workflow_path}/data/diagram-types.csv'
|
|
893
|
+
sectionStructureData: '{workflow_path}/data/section-structure.csv'
|
|
894
|
+
|
|
895
|
+
# Core workflows
|
|
896
|
+
advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
|
|
897
|
+
partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
|
|
898
|
+
|
|
899
|
+
# Config
|
|
900
|
+
bmmConfig: '{project-root}/_bmad/bmm/config.yaml'
|
|
901
|
+
```
|
|
902
|
+
|
|
903
|
+
### Special Mechanisms
|
|
904
|
+
|
|
905
|
+
**Continuation Detection (step-01-init):**
|
|
906
|
+
```
|
|
907
|
+
1. Check if outputFile exists with frontmatter.stepsCompleted not empty
|
|
908
|
+
2. IF YES: Load step-01b-continue.md (resume from saved state)
|
|
909
|
+
3. IF NO: Continue with normal initialization
|
|
910
|
+
```
|
|
911
|
+
|
|
912
|
+
**Loop Mechanism (step-07 → step-05):**
|
|
913
|
+
```
|
|
914
|
+
In step-07, menu option [F] Fix Issues:
|
|
915
|
+
1. Collect list of validation issues
|
|
916
|
+
2. Store corrections in sidecar
|
|
917
|
+
3. Load step-05-generacion-espanol.md with corrections context
|
|
918
|
+
4. Re-generate affected sections
|
|
919
|
+
5. Return to step-07 for validation
|
|
920
|
+
```
|
|
921
|
+
|
|
922
|
+
**Progress Tracking (all steps):**
|
|
923
|
+
```
|
|
924
|
+
Before loading next step:
|
|
925
|
+
1. Update frontmatter.stepsCompleted (add current step number)
|
|
926
|
+
2. Update frontmatter.currentStep (set to next step name)
|
|
927
|
+
3. Update frontmatter.last_modified (timestamp)
|
|
928
|
+
4. Save outputFile
|
|
929
|
+
5. Update sidecar file
|
|
930
|
+
```
|
|
931
|
+
|
|
932
|
+
### Menu Options Standard
|
|
933
|
+
|
|
934
|
+
**All steps include:**
|
|
935
|
+
- `[A]` Advanced - Deep dive using Advanced Elicitation workflow
|
|
936
|
+
- `[P]` Party Mode - Collaborative discussion with other BMAD agents
|
|
937
|
+
- `[C]` Continue - Proceed to next step
|
|
938
|
+
|
|
939
|
+
**Additional options per step:**
|
|
940
|
+
- step-01b: `[R]` Review Progress, `[M]` Modify
|
|
941
|
+
- step-02: `[R]` Refresh (re-scan epics)
|
|
942
|
+
- step-03: `[R]` Re-scan (re-scan artifacts)
|
|
943
|
+
- step-07: `[V]` Validate, `[F]` Fix Issues, `[S]` Save
|
|
944
|
+
|
|
945
|
+
---
|
|
946
|
+
|
|
947
|
+
## Next Steps
|
|
948
|
+
|
|
949
|
+
Workflow structure design complete. Ready to proceed to workflow build phase.
|