d260c65769
- Created a prompt for .NET/C# best practices to ensure code quality and adherence to standards. - Added a design pattern review prompt for evaluating C#/.NET code implementations. - Introduced prompts for suggesting relevant GitHub Copilot chatmodes and prompts based on repository context. - Developed a prompt for updating Azure Verified Modules in Bicep files to the latest versions. - Implemented a prompt for updating implementation plans with new requirements and features. - Created a prompt for updating the llms.txt file to reflect changes in documentation or specifications. - Added a prompt for updating markdown file indexes with files from specified folders. - Developed a prompt for updating object-oriented component documentation according to best practices. - Created a prompt for updating specification files to align with new requirements and ensure AI-readiness.
98 lines
3.2 KiB
Markdown
98 lines
3.2 KiB
Markdown
---
|
|
mode: 'agent'
|
|
description: Create an Architectural Decision Record (ADR) document for AI-optimized decision documentation.
|
|
tools: ['changes', 'codebase', 'editFiles', 'extensions', 'fetch', 'githubRepo', 'openSimpleBrowser', 'problems', 'runTasks', 'search', 'searchResults', 'terminalLastCommand', 'terminalSelection', 'testFailure', 'usages', 'vscodeAPI']
|
|
---
|
|
# Create Architectural Decision Record
|
|
|
|
Create an ADR document for `${input:DecisionTitle}` using structured formatting optimized for AI consumption and human readability.
|
|
|
|
## Inputs
|
|
|
|
- **Context**: `${input:Context}`
|
|
- **Decision**: `${input:Decision}`
|
|
- **Alternatives**: `${input:Alternatives}`
|
|
- **Stakeholders**: `${input:Stakeholders}`
|
|
|
|
## Input Validation
|
|
If any of the required inputs are not provided or cannot be determined from the conversation history, ask the user to provide the missing information before proceeding with ADR generation.
|
|
|
|
## Requirements
|
|
|
|
- Use precise, unambiguous language
|
|
- Follow standardized ADR format with front matter
|
|
- Include both positive and negative consequences
|
|
- Document alternatives with rejection rationale
|
|
- Structure for machine parsing and human reference
|
|
- Use coded bullet points (3-4 letter codes + 3-digit numbers) for multi-item sections
|
|
|
|
The ADR must be saved in the `/docs/adr/` directory using the naming convention: `adr-NNNN-[title-slug].md`, where NNNN is the next sequential 4-digit number (e.g., `adr-0001-database-selection.md`).
|
|
|
|
## Required Documentation Structure
|
|
|
|
The documentation file must follow the template below, ensuring that all sections are filled out appropriately. The front matter for the markdown should be structured correctly as per the example following:
|
|
|
|
```md
|
|
---
|
|
title: "ADR-NNNN: [Decision Title]"
|
|
status: "Proposed"
|
|
date: "YYYY-MM-DD"
|
|
authors: "[Stakeholder Names/Roles]"
|
|
tags: ["architecture", "decision"]
|
|
supersedes: ""
|
|
superseded_by: ""
|
|
---
|
|
|
|
# ADR-NNNN: [Decision Title]
|
|
|
|
## Status
|
|
|
|
**Proposed** | Accepted | Rejected | Superseded | Deprecated
|
|
|
|
## Context
|
|
|
|
[Problem statement, technical constraints, business requirements, and environmental factors requiring this decision.]
|
|
|
|
## Decision
|
|
|
|
[Chosen solution with clear rationale for selection.]
|
|
|
|
## Consequences
|
|
|
|
### Positive
|
|
|
|
- **POS-001**: [Beneficial outcomes and advantages]
|
|
- **POS-002**: [Performance, maintainability, scalability improvements]
|
|
- **POS-003**: [Alignment with architectural principles]
|
|
|
|
### Negative
|
|
|
|
- **NEG-001**: [Trade-offs, limitations, drawbacks]
|
|
- **NEG-002**: [Technical debt or complexity introduced]
|
|
- **NEG-003**: [Risks and future challenges]
|
|
|
|
## Alternatives Considered
|
|
|
|
### [Alternative 1 Name]
|
|
|
|
- **ALT-001**: **Description**: [Brief technical description]
|
|
- **ALT-002**: **Rejection Reason**: [Why this option was not selected]
|
|
|
|
### [Alternative 2 Name]
|
|
|
|
- **ALT-003**: **Description**: [Brief technical description]
|
|
- **ALT-004**: **Rejection Reason**: [Why this option was not selected]
|
|
|
|
## Implementation Notes
|
|
|
|
- **IMP-001**: [Key implementation considerations]
|
|
- **IMP-002**: [Migration or rollout strategy if applicable]
|
|
- **IMP-003**: [Monitoring and success criteria]
|
|
|
|
## References
|
|
|
|
- **REF-001**: [Related ADRs]
|
|
- **REF-002**: [External documentation]
|
|
- **REF-003**: [Standards or frameworks referenced]
|
|
```
|