@riotprompt/riotdoc 1.0.1-dev.0 → 1.0.4

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.
@@ -0,0 +1,513 @@
1
+ # Project Plan Document Template
2
+
3
+ ## Template Structure
4
+
5
+ This defines the structure and questions for creating project plan documents in RiotDoc.
6
+
7
+ **Template Type**: project-plan
8
+ **Version**: 2.0
9
+ **Last Updated**: 2026-01-30
10
+
11
+ ---
12
+
13
+ ## Questions to Answer
14
+
15
+ ### Idea/Draft Phase
16
+
17
+ These are the questions you can answer **NOW** when initiating the project. Focus on the core goals and approach.
18
+
19
+ #### Project Basics
20
+ - **Project name**: What's the project called?
21
+ - **Project goal**: What are you trying to achieve? (one clear sentence)
22
+ - **Why now**: Why is this project important right now?
23
+ - **Stakeholders**: Who's involved? Who cares about this?
24
+ - **Timeline**: When does this need to be done? (rough estimate)
25
+
26
+ #### Scope Definition
27
+ - **In scope**: What's included in this project?
28
+ - **Out of scope**: What's explicitly NOT included?
29
+ - **Deliverables**: What will be produced?
30
+ - **Success criteria**: How will you know it's successful?
31
+
32
+ #### Approach & Methodology
33
+ - **Methodology**: Agile, waterfall, hybrid, custom?
34
+ - **Phases**: What are the major phases or milestones?
35
+ - **Team structure**: Who's doing what? (roles, not necessarily names)
36
+
37
+ ---
38
+
39
+ ### Publishing Phase
40
+
41
+ These are questions you figure out **LATER** - as you develop the detailed plan.
42
+
43
+ #### Detailed Planning
44
+ - **Dependencies**: What needs to happen first? External dependencies?
45
+ - **Risks**: What could go wrong? What's the mitigation strategy?
46
+ - **Budget/resources**: Detailed resource allocation and costs?
47
+ - **Constraints**: Technical, legal, or business constraints?
48
+
49
+ #### Team & Communication
50
+ - **Team assignments**: Specific people assigned to roles?
51
+ - **Communication plan**: How will the team stay in sync? (meetings, tools, frequency)
52
+ - **Decision-making**: Who approves what? What's the escalation path?
53
+ - **Reporting**: How often and to whom? What format?
54
+
55
+ #### Documentation & Governance
56
+ - **Documentation**: Where will project docs live?
57
+ - **Change management**: How will scope changes be handled?
58
+ - **Quality assurance**: How will quality be ensured?
59
+ - **Post-project review**: How will you capture learnings?
60
+
61
+ ---
62
+
63
+ ## Available Approaches
64
+
65
+ Choose the approach that best fits your project type and organizational culture.
66
+
67
+ ### Approach 1: Agile Sprint Plan
68
+
69
+ **When to use**:
70
+ - Software development or product work
71
+ - Requirements may evolve
72
+ - Need flexibility and iteration
73
+ - Team works in sprints (1-4 weeks)
74
+ - Continuous delivery expected
75
+
76
+ **Strategy**:
77
+ - Define high-level goal and backlog
78
+ - Plan first sprint in detail, later sprints roughly
79
+ - Iterate and adapt based on feedback
80
+ - Regular retrospectives and adjustments
81
+
82
+ **Output**: Sprint-based project plan with backlog
83
+
84
+ **Workflow**:
85
+ 1. Answer Idea/Draft phase questions
86
+ 2. Create product backlog (user stories or tasks)
87
+ 3. Prioritize backlog
88
+ 4. Plan first sprint (2 weeks typical):
89
+ - Select stories from backlog
90
+ - Break into tasks
91
+ - Estimate effort
92
+ 5. Define sprint ceremonies:
93
+ - Daily standup
94
+ - Sprint review
95
+ - Sprint retrospective
96
+ - Sprint planning
97
+ 6. Answer Publishing phase questions
98
+ 7. Document communication plan
99
+ 8. Start first sprint
100
+ 9. Adapt plan based on learnings
101
+
102
+ **Timeline**: Ongoing, reviewed every sprint
103
+
104
+ **Plan Structure**:
105
+ - Product vision and goals
106
+ - Backlog of features/stories
107
+ - Sprint 1 detailed plan
108
+ - Sprint 2+ rough outline
109
+ - Team structure and ceremonies
110
+
111
+ ---
112
+
113
+ ### Approach 2: Waterfall Project Plan
114
+
115
+ **When to use**:
116
+ - Well-defined requirements
117
+ - Fixed scope and timeline
118
+ - Sequential phases make sense
119
+ - Regulatory or compliance requirements
120
+ - Traditional project management environment
121
+
122
+ **Strategy**:
123
+ - Plan entire project upfront in detail
124
+ - Sequential phases with gates
125
+ - Detailed documentation at each phase
126
+ - Change control process for scope changes
127
+
128
+ **Output**: Comprehensive project plan with phases and gates
129
+
130
+ **Workflow**:
131
+ 1. Answer all Idea/Draft phase questions
132
+ 2. Define all phases in detail:
133
+ - Requirements gathering
134
+ - Design
135
+ - Implementation
136
+ - Testing
137
+ - Deployment
138
+ 3. Create detailed timeline with milestones
139
+ 4. Identify dependencies between phases
140
+ 5. Answer all Publishing phase questions
141
+ 6. Document risks and mitigation
142
+ 7. Create communication and reporting plan
143
+ 8. Define change control process
144
+ 9. Get stakeholder approval
145
+ 10. Execute phase by phase
146
+
147
+ **Timeline**: Full project planned upfront (weeks to months)
148
+
149
+ **Plan Structure**:
150
+ - Executive summary
151
+ - Detailed scope and requirements
152
+ - Phase-by-phase breakdown
153
+ - Resource allocation
154
+ - Risk management plan
155
+ - Communication plan
156
+
157
+ ---
158
+
159
+ ### Approach 3: Hybrid Approach
160
+
161
+ **When to use**:
162
+ - Mix of known and unknown requirements
163
+ - Some phases can be agile, others need structure
164
+ - Need flexibility but also predictability
165
+ - Cross-functional team with different working styles
166
+ - Organizational constraints require some waterfall elements
167
+
168
+ **Strategy**:
169
+ - Plan high-level phases (waterfall-style)
170
+ - Execute phases using agile practices
171
+ - Fixed milestones with flexible execution
172
+ - Adapt approach per phase as needed
173
+
174
+ **Output**: Hybrid plan with phase structure and iterative execution
175
+
176
+ **Workflow**:
177
+ 1. Answer Idea/Draft phase questions
178
+ 2. Define major phases and milestones (waterfall)
179
+ 3. For each phase, plan iterative approach (agile):
180
+ - Break into 1-2 week cycles
181
+ - Define phase goal and deliverables
182
+ - Allow flexibility in how to achieve
183
+ 4. Identify which phases need more structure vs flexibility
184
+ 5. Answer Publishing phase questions
185
+ 6. Create communication plan that works for both styles
186
+ 7. Document when to use agile vs waterfall practices
187
+ 8. Execute with regular check-ins and adaptations
188
+
189
+ **Timeline**: Phases planned upfront, execution iterative
190
+
191
+ **Plan Structure**:
192
+ - Phase-based timeline with milestones
193
+ - Iterative execution within phases
194
+ - Flexibility where needed, structure where required
195
+ - Regular review and adaptation points
196
+
197
+ ---
198
+
199
+ ## Output Document Structure
200
+
201
+ ```markdown
202
+ # Project Plan: [Project Name]
203
+
204
+ **Status**: [Planning/In Progress/Complete]
205
+ **Timeline**: [Start Date] - [End Date]
206
+ **Last Updated**: [Date]
207
+
208
+ ---
209
+
210
+ ## Executive Summary
211
+
212
+ [2-3 paragraph overview covering:
213
+ - What is the project?
214
+ - Why are we doing it?
215
+ - What will be delivered?
216
+ - When will it be done?]
217
+
218
+ ---
219
+
220
+ ## Project Overview
221
+
222
+ ### Goal
223
+ [Primary goal in one clear sentence]
224
+
225
+ ### Why Now
226
+ [Why this project is important right now]
227
+
228
+ ### Timeline
229
+ - **Start**: [Date]
230
+ - **End**: [Date]
231
+ - **Duration**: [X weeks/months]
232
+
233
+ ### Budget
234
+ [Budget or resource allocation]
235
+
236
+ ### Stakeholders
237
+ - **Sponsor**: [Name and role]
238
+ - **Project Lead**: [Name]
239
+ - **Key Stakeholders**: [List]
240
+
241
+ ---
242
+
243
+ ## Scope
244
+
245
+ ### In Scope
246
+ - [Item 1]
247
+ - [Item 2]
248
+ - [Item 3]
249
+
250
+ ### Out of Scope
251
+ - [Item 1]
252
+ - [Item 2]
253
+
254
+ ### Deliverables
255
+ 1. **[Deliverable 1]**: [Description]
256
+ 2. **[Deliverable 2]**: [Description]
257
+ 3. **[Deliverable 3]**: [Description]
258
+
259
+ ### Success Criteria
260
+ - [ ] [Criterion 1]
261
+ - [ ] [Criterion 2]
262
+ - [ ] [Criterion 3]
263
+
264
+ ---
265
+
266
+ ## Approach
267
+
268
+ ### Methodology
269
+ [Agile/Waterfall/Hybrid - with brief description of how it will work]
270
+
271
+ ### Phases & Milestones
272
+
273
+ #### Phase 1: [Name]
274
+ **Timeline**: [Dates]
275
+ **Goal**: [What this phase achieves]
276
+ **Deliverables**:
277
+ - [Deliverable 1]
278
+ - [Deliverable 2]
279
+ **Milestone**: [Key milestone]
280
+
281
+ #### Phase 2: [Name]
282
+ **Timeline**: [Dates]
283
+ **Goal**: [What this phase achieves]
284
+ **Deliverables**:
285
+ - [Deliverable 1]
286
+ - [Deliverable 2]
287
+ **Milestone**: [Key milestone]
288
+
289
+ [Additional phases as needed]
290
+
291
+ ---
292
+
293
+ ## Dependencies
294
+
295
+ ### Internal Dependencies
296
+ - [Dependency 1 - what needs to happen first]
297
+ - [Dependency 2]
298
+
299
+ ### External Dependencies
300
+ - [External dependency 1 - outside team/vendor]
301
+ - [External dependency 2]
302
+
303
+ ---
304
+
305
+ ## Risks & Mitigation
306
+
307
+ | Risk | Impact | Probability | Mitigation Strategy |
308
+ |------|--------|-------------|---------------------|
309
+ | [Risk 1] | High/Med/Low | High/Med/Low | [How we'll address it] |
310
+ | [Risk 2] | High/Med/Low | High/Med/Low | [How we'll address it] |
311
+ | [Risk 3] | High/Med/Low | High/Med/Low | [How we'll address it] |
312
+
313
+ ---
314
+
315
+ ## Team & Responsibilities
316
+
317
+ | Role | Person | Responsibilities |
318
+ |------|--------|------------------|
319
+ | Project Lead | [Name] | [Overall project management, decisions] |
320
+ | [Role 2] | [Name] | [Specific responsibilities] |
321
+ | [Role 3] | [Name] | [Specific responsibilities] |
322
+
323
+ ---
324
+
325
+ ## Communication Plan
326
+
327
+ ### Team Meetings
328
+ - **Frequency**: [Daily/Weekly/Bi-weekly]
329
+ - **Format**: [Standup/Status meeting/Review]
330
+ - **Duration**: [X minutes]
331
+ - **Attendees**: [Who attends]
332
+
333
+ ### Status Reports
334
+ - **Frequency**: [Weekly/Bi-weekly/Monthly]
335
+ - **Audience**: [Stakeholders/Leadership]
336
+ - **Format**: [Email/Dashboard/Presentation]
337
+ - **Content**: [Progress, blockers, upcoming]
338
+
339
+ ### Decision Log
340
+ - **Location**: [Where decisions are recorded]
341
+ - **Process**: [How decisions are made and documented]
342
+
343
+ ### Escalation Path
344
+ 1. [First level - Project Lead]
345
+ 2. [Second level - Manager/Sponsor]
346
+ 3. [Third level - Executive]
347
+
348
+ ---
349
+
350
+ ## Resources & Budget
351
+
352
+ ### Team Resources
353
+ - [X] Full-time equivalents (FTEs)
354
+ - [List of team members and allocation %]
355
+
356
+ ### Budget Breakdown
357
+ - Personnel: [$X]
358
+ - Tools/Software: [$X]
359
+ - External vendors: [$X]
360
+ - Contingency: [$X]
361
+ - **Total**: [$X]
362
+
363
+ ---
364
+
365
+ ## Quality Assurance
366
+
367
+ ### Quality Standards
368
+ - [Standard 1]
369
+ - [Standard 2]
370
+
371
+ ### Review Process
372
+ - [How work will be reviewed]
373
+ - [Who approves what]
374
+
375
+ ### Testing Strategy
376
+ - [How deliverables will be tested]
377
+
378
+ ---
379
+
380
+ ## Change Management
381
+
382
+ ### Scope Change Process
383
+ 1. [Request submitted via X]
384
+ 2. [Impact assessment by project lead]
385
+ 3. [Approval required from Y]
386
+ 4. [Plan updated and communicated]
387
+
388
+ ### Change Log
389
+ | Date | Change | Requestor | Status | Impact |
390
+ |------|--------|-----------|--------|--------|
391
+ | [Date] | [Description] | [Name] | [Approved/Rejected] | [Impact on timeline/budget] |
392
+
393
+ ---
394
+
395
+ ## Appendices
396
+
397
+ ### Supporting Documents
398
+ - [Link to requirements doc]
399
+ - [Link to design specs]
400
+ - [Link to technical architecture]
401
+
402
+ ### References
403
+ - [Related projects]
404
+ - [Industry standards]
405
+ - [Research or background materials]
406
+ ```
407
+
408
+ ---
409
+
410
+ ## Example Use Cases
411
+
412
+ ### Software Development
413
+ - New feature development
414
+ - Platform migration
415
+ - System integration
416
+ - Technical debt reduction
417
+
418
+ ### Marketing
419
+ - Product launch campaign
420
+ - Rebranding initiative
421
+ - Content strategy rollout
422
+ - Event planning
423
+
424
+ ### Operations
425
+ - Process improvement
426
+ - Infrastructure upgrade
427
+ - Tool implementation
428
+ - Organizational change
429
+
430
+ ### Research
431
+ - Research study
432
+ - Data analysis project
433
+ - Pilot program
434
+ - Feasibility study
435
+
436
+ ---
437
+
438
+ ## Project Planning Tips
439
+
440
+ ### For Agile Sprint Plans
441
+ - Keep backlog groomed and prioritized
442
+ - Plan only 1-2 sprints ahead in detail
443
+ - Review and adapt after each sprint
444
+ - Focus on delivering value incrementally
445
+ - Don't over-plan - embrace change
446
+
447
+ ### For Waterfall Plans
448
+ - Invest time in upfront planning
449
+ - Document everything thoroughly
450
+ - Get stakeholder sign-off at each gate
451
+ - Manage scope changes carefully
452
+ - Plan for testing and deployment
453
+
454
+ ### For Hybrid Approaches
455
+ - Be clear when using agile vs waterfall
456
+ - Communicate approach to all stakeholders
457
+ - Adapt based on what's working
458
+ - Don't force one approach everywhere
459
+ - Balance flexibility with predictability
460
+
461
+ ---
462
+
463
+ ## Common Pitfalls to Avoid
464
+
465
+ ❌ **Don't**: Start without clear success criteria
466
+ ✅ **Do**: Define measurable success criteria upfront
467
+
468
+ ❌ **Don't**: Underestimate dependencies
469
+ ✅ **Do**: Map all dependencies early and track them
470
+
471
+ ❌ **Don't**: Ignore risks until they become issues
472
+ ✅ **Do**: Identify and mitigate risks proactively
473
+
474
+ ❌ **Don't**: Over-plan in agile or under-plan in waterfall
475
+ ✅ **Do**: Match planning detail to your methodology
476
+
477
+ ❌ **Don't**: Forget to communicate regularly
478
+ ✅ **Do**: Establish communication rhythm from day one
479
+
480
+ ❌ **Don't**: Let scope creep without process
481
+ ✅ **Do**: Have clear change management process
482
+
483
+ ---
484
+
485
+ ## Template Notes
486
+
487
+ **Version 2.0 Changes** (2026-01-30):
488
+ - Split questions into Idea/Draft and Publishing phases
489
+ - Added three approaches: Agile Sprint, Waterfall, Hybrid
490
+ - Added detailed workflows for each approach
491
+ - Enhanced risk management and communication planning
492
+ - Follows canonical template structure from TEMPLATE-STRUCTURE.md
493
+
494
+ **When to use this template**:
495
+ - Starting a new project (any size)
496
+ - Need to communicate project plan to stakeholders
497
+ - Want structured approach to project execution
498
+ - Need to track progress and manage changes
499
+
500
+ ---
501
+
502
+ ## Related Templates
503
+
504
+ - **Meeting Notes Template**: For project meetings
505
+ - **Blog Post Template**: For project updates or announcements
506
+ - **Email Template**: For stakeholder communication
507
+
508
+ ---
509
+
510
+ ## Version History
511
+
512
+ - **v2.0** (2026-01-30): Added lifecycle phases and approaches
513
+ - **v1.0** (2026-01-XX): Initial template (no phase split)