Skip to content

Commit 0c19b2f

Browse files
committed
docs(governance): add generalized research report template
1 parent 6d3af0c commit 0c19b2f

1 file changed

Lines changed: 236 additions & 0 deletions

File tree

Lines changed: 236 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,236 @@
1+
# Section [NN]: [Topic Title] - Research Report
2+
3+
**Topic ID:** [Must match overall research plan index, e.g., IDR-SRV-001]
4+
**Report Status:** [Draft | In Review | Final]
5+
**Research Plan:** [Relative or absolute link to topic research plan]
6+
**Overall Research Plan:** [Relative or absolute link to controlling overall research plan]
7+
**Research Questions Covered:** [Count and short scope statement]
8+
**Methodology Used:** [Short summary of how research was performed]
9+
**Research Time:** [Actual time spent and date range]
10+
**Primary Source(s):**
11+
- [Authoritative source URL/path]
12+
- [Authoritative source URL/path]
13+
**Supporting Resources:**
14+
- [Related report or plan]
15+
- [Related report or plan]
16+
**Document Purpose:** [What decision(s) this report enables]
17+
**Author(s):** [Name/Team]
18+
**Date:** [Month Day, Year]
19+
**Last Updated:** [Month Day, Year]
20+
21+
---
22+
23+
## Usage Rules
24+
25+
This report template is for topic-level reports that must correlate to governance topic plans.
26+
27+
1. `Topic ID` must exactly match the ID in the overall research plan index.
28+
2. `Research Plan` must link to the corresponding topic-specific research plan.
29+
3. Every conclusion must be backed by explicit evidence and references.
30+
4. Recommendations must be decision-usable, not descriptive only.
31+
5. Report is final only when all core questions from the topic plan are addressed or explicitly marked unresolved.
32+
33+
---
34+
35+
## Table of Contents
36+
37+
1. Executive Summary
38+
2. Scope and Plan Alignment
39+
3. Evidence Base
40+
4. Findings by Research Question
41+
5. Decision Analysis
42+
6. Key Recommendations
43+
7. Implementation Implications and Estimates
44+
8. Risks, Constraints, and Open Questions
45+
9. Validation Against Plan Success Criteria
46+
10. Next Steps and Handoff
47+
11. References
48+
12. Appendices (Optional)
49+
50+
---
51+
52+
## 1. Executive Summary
53+
54+
Provide a concise, decision-oriented summary.
55+
56+
- Problem or decision context
57+
- Most important findings
58+
- Final recommendation
59+
- Notable unresolved risk (if any)
60+
61+
---
62+
63+
## 2. Scope and Plan Alignment
64+
65+
Show explicit correlation to governance planning artifacts.
66+
67+
- Topic ID and title confirmation
68+
- Topic plan objective coverage statement
69+
- In-scope items completed
70+
- Out-of-scope items (if any)
71+
72+
### Research Question Coverage Matrix
73+
74+
| Plan Question ID | Question (Short Form) | Coverage Status | Evidence Location |
75+
|---|---|---|---|
76+
| [Q1] | [Question summary] | [Complete/Partial/Unresolved] | [Section/appendix/reference] |
77+
| [Q2] | [Question summary] | [Complete/Partial/Unresolved] | [Section/appendix/reference] |
78+
79+
---
80+
81+
## 3. Evidence Base
82+
83+
Document the evidence used and how it was validated.
84+
85+
### 3.1 Primary Sources Reviewed
86+
87+
| Source | Type | Why It Is Authoritative | Access Date | Notes |
88+
|---|---|---|---|---|
89+
| [URL/path] | [Spec/code/repo/etc.] | [Justification] | [YYYY-MM-DD] | [Note] |
90+
91+
### 3.2 Supporting Sources Reviewed
92+
93+
| Source | Relevance | Access Date | Notes |
94+
|---|---|---|---|
95+
| [URL/path] | [How used] | [YYYY-MM-DD] | [Note] |
96+
97+
### 3.3 Evidence Quality Notes
98+
99+
- [Any caveat, data limitation, missing source, or confidence note]
100+
101+
---
102+
103+
## 4. Findings by Research Question
104+
105+
Report findings grouped by topic-plan questions, not by ad hoc narrative.
106+
107+
### 4.1 [Question ID/Theme]
108+
109+
**Finding:** [Clear statement]
110+
111+
**Evidence:**
112+
- [Direct source citation with specific section/path]
113+
- [Direct source citation with specific section/path]
114+
115+
**Interpretation:** [What the evidence means for this topic]
116+
117+
### 4.2 [Question ID/Theme]
118+
119+
**Finding:** [Clear statement]
120+
121+
**Evidence:**
122+
- [Direct source citation]
123+
124+
**Interpretation:** [Decision-relevant meaning]
125+
126+
---
127+
128+
## 5. Decision Analysis
129+
130+
Evaluate viable options and trade-offs before final recommendation.
131+
132+
| Option | Benefits | Costs/Risks | Standards/Compatibility Impact | Recommendation |
133+
|---|---|---|---|---|
134+
| [Option A] | [Benefit] | [Cost/risk] | [Impact] | [Keep/Reject/Conditional] |
135+
| [Option B] | [Benefit] | [Cost/risk] | [Impact] | [Keep/Reject/Conditional] |
136+
137+
---
138+
139+
## 6. Key Recommendations
140+
141+
Provide explicit, bounded, actionable recommendations.
142+
143+
1. [Recommendation statement]
144+
- Rationale: [Short rationale]
145+
- Preconditions: [If any]
146+
- Priority: [High/Medium/Low]
147+
2. [Recommendation statement]
148+
- Rationale: [Short rationale]
149+
- Preconditions: [If any]
150+
- Priority: [High/Medium/Low]
151+
152+
---
153+
154+
## 7. Implementation Implications and Estimates
155+
156+
Capture practical downstream impact for planning artifacts.
157+
158+
### 7.1 Implications
159+
160+
- [Architecture implication]
161+
- [Implementation implication]
162+
- [Testing or validation implication]
163+
164+
### 7.2 Effort/Complexity Estimate
165+
166+
| Work Item | Relative Complexity | Estimate | Assumptions |
167+
|---|---|---|---|
168+
| [Item] | [Low/Medium/High] | [Time/points] | [Assumptions] |
169+
170+
---
171+
172+
## 8. Risks, Constraints, and Open Questions
173+
174+
### 8.1 Risks and Constraints
175+
176+
- [Risk/constraint]
177+
- [Risk/constraint]
178+
179+
### 8.2 Open Questions
180+
181+
- [Open question and why unresolved]
182+
- [Open question and next action]
183+
184+
---
185+
186+
## 9. Validation Against Plan Success Criteria
187+
188+
Map report outcomes back to the topic plan success criteria.
189+
190+
| Topic Plan Success Criterion | Validation Status | Evidence |
191+
|---|---|---|
192+
| [Criterion] | [Met/Partially Met/Not Met] | [Section/reference] |
193+
| [Criterion] | [Met/Partially Met/Not Met] | [Section/reference] |
194+
195+
---
196+
197+
## 10. Next Steps and Handoff
198+
199+
Define immediate follow-on work and ownership.
200+
201+
1. [Next action] - Owner: [Name/Team] - Due: [YYYY-MM-DD]
202+
2. [Next action] - Owner: [Name/Team] - Due: [YYYY-MM-DD]
203+
204+
---
205+
206+
## 11. References
207+
208+
List all cited sources with reproducible links.
209+
210+
- [Full URL or repository path]
211+
- [Full URL or repository path]
212+
- [Full URL or repository path]
213+
214+
---
215+
216+
## 12. Appendices (Optional)
217+
218+
Include supporting detail that would otherwise disrupt report readability.
219+
220+
- Raw extraction tables
221+
- Command logs
222+
- Comparison matrices
223+
- Supplemental examples
224+
225+
---
226+
227+
## Report Completion Checklist
228+
229+
- [ ] Topic ID matches overall research plan index
230+
- [ ] Topic research plan is linked and aligned
231+
- [ ] Core research questions are covered or explicitly unresolved
232+
- [ ] Findings are evidence-backed with reproducible references
233+
- [ ] Recommendations are explicit and actionable
234+
- [ ] Risks and open questions are documented
235+
- [ ] Success criteria validation is complete
236+
- [ ] Next steps are assigned

0 commit comments

Comments
 (0)