initial commit - start with decision documents
This commit is contained in:
commit
45241d32b5
13
docs/decisions/001-decisions.md
Normal file
13
docs/decisions/001-decisions.md
Normal file
@ -0,0 +1,13 @@
|
||||
# Use Decision Documents to Capture Decision hitory
|
||||
|
||||
## Context and Background
|
||||
|
||||
Guidehouse teams are trying to reduce effort by sharing code via a monorepo. Inevitable sharing code can blend development styles. As
|
||||
we attempt to standardize, it will be helpful to keep track of critical decisions and the rational behind them.
|
||||
|
||||
## Decision
|
||||
|
||||
Use a decision document to keep track of the rational of a decision. This will be most useful when alternatives come up. The level of detail should represent the gravity of the decision and the complexity of the problem space.
|
||||
|
||||
|
||||
*This document follows the [Decision Document Template](template.md).*
|
||||
92
docs/decisions/template.md
Normal file
92
docs/decisions/template.md
Normal file
@ -0,0 +1,92 @@
|
||||
# Decision Document Template
|
||||
|
||||
> **Instructions:** Copy this template for new decisions. Replace all placeholder text with actual content. Delete this instruction block when creating a real decision document.
|
||||
|
||||
## Context and Background
|
||||
|
||||
Describe the situation that led to this decision. Include:
|
||||
- What circumstances created the need for this decision?
|
||||
- What is the current state?
|
||||
- Any relevant historical context or previous decisions?
|
||||
|
||||
## Problem Statement
|
||||
|
||||
Clearly articulate the problem being solved:
|
||||
- What specific issue are we addressing?
|
||||
- Who is affected by this problem?
|
||||
- What happens if we don't make a decision?
|
||||
- Any constraints or requirements that must be considered?
|
||||
|
||||
## Decision
|
||||
|
||||
**We have decided to [clear, actionable decision statement].**
|
||||
|
||||
Provide additional details about the decision:
|
||||
- Specific implementation details
|
||||
- Timeline for implementation
|
||||
- Success criteria
|
||||
- Any conditions or assumptions
|
||||
|
||||
## Alternatives Considered
|
||||
|
||||
Document the options that were evaluated:
|
||||
|
||||
### Option 1: [Name]
|
||||
- **Description:** Brief explanation of this approach
|
||||
- **Pros:** What are the advantages?
|
||||
- **Cons:** What are the drawbacks?
|
||||
- **Cost/Effort:** Implementation complexity and resource requirements
|
||||
|
||||
### Option 2: [Name]
|
||||
- **Description:** Brief explanation of this approach
|
||||
- **Pros:** What are the advantages?
|
||||
- **Cons:** What are the drawbacks?
|
||||
- **Cost/Effort:** Implementation complexity and resource requirements
|
||||
|
||||
### Option 3: Do Nothing
|
||||
- **Description:** Maintain the status quo
|
||||
- **Pros:** No implementation cost
|
||||
- **Cons:** Problems remain unresolved
|
||||
- **Cost/Effort:** Ongoing maintenance burden
|
||||
|
||||
## Rationale
|
||||
|
||||
Explain why the chosen option was selected:
|
||||
- What factors were most important in the decision?
|
||||
- How does this align with organizational goals/principles?
|
||||
- What assumptions are we making?
|
||||
- Risk assessment and mitigation strategies
|
||||
|
||||
## Consequences
|
||||
|
||||
### Positive Consequences
|
||||
- What benefits do we expect?
|
||||
- How will success be measured?
|
||||
- What opportunities does this create?
|
||||
|
||||
### Negative Consequences
|
||||
- What trade-offs are we accepting?
|
||||
- What new risks are introduced?
|
||||
- What technical debt might be created?
|
||||
|
||||
### Neutral Consequences
|
||||
- What changes but neither helps nor hurts?
|
||||
- What operational changes are required?
|
||||
|
||||
## Implementation Plan
|
||||
|
||||
If applicable, provide a high-level implementation approach:
|
||||
- Key milestones and timeline
|
||||
- Required resources
|
||||
- Dependencies
|
||||
- Risk mitigation strategies
|
||||
- Rollback plan
|
||||
|
||||
## Follow-up Actions
|
||||
|
||||
- [ ] Action item 1 (Owner: Name, Due: Date)
|
||||
- [ ] Action item 2 (Owner: Name, Due: Date)
|
||||
- [ ] Review decision effectiveness (Date)
|
||||
|
||||
|
||||
*This document follows the [Decision Document Template](template.md).*
|
||||
Loading…
x
Reference in New Issue
Block a user