Skip to main content

create-architectural-decision-record

Create an Architectural Decision Record (ADR) document for AI-optimized decision documentation.

Ir para a instalação

Informações da origem

Repositório
markheydon/freeagent-dotnet
Última atividade na origem
2 de setembro de 2026 às 21:21
Idioma detectado do SKILL.md
inglês
Estrelas
0
Forks
0

Opções de instalação

Por padrão, está selecionado o prompt que primeiro revisa a origem. Você pode mudar para um comando direto ou baixar uma cópia local.

Revise os arquivos de origem

Leia o SKILL.md e os arquivos complementares exibidos pelo SkillsMP antes de decidir se vai instalar.

Exibindo SKILL.md

SKILL.md
Instruções da origem · Visualização somente leitura
name
create-architectural-decision-record
description
Create an Architectural Decision Record (ADR) document for AI-optimized decision documentation.
# 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 repository-root `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`). Do not save ADRs under `docs/`. ## 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] ```
Ver no GitHub