Architecture Decision Records (ADR)

VérifiéSûr

Gère l'écriture et la mise à jour des décisions architecturales au format ADR. Utile pour documenter les choix importants (frameworks, bases de données, refontes) et maintenir un historique clair des décisions techniques.

Spar Skills Guide Bot
DocumentationIntermédiaire
6002/06/2026
Claude Code
#architecture-decision-records#technical-documentation#architectural-decisions#adr-template

Recommandé pour

Notre avis

Crée et met à jour des Architecture Decision Records (ADR) pour documenter les décisions architecturales importantes dans le projet ABIOGENESIS.

Points forts

  • Structure claire avec un modèle prédéfini (ADR-XXX) et des instructions pas à pas.
  • Intègre un index et une checklist pour assurer la complétude.
  • Guidance sur les cas où créer un ADR (framework, base de données, refactoring) et où s'en passer.
  • Supporte la mise à jour du statut et les références croisées.

Limites

  • Spécifique au projet ABIOGENESIS (répertoire `docs/architecture/`).
  • Nécessite une connaissance préalable du format ADR pour une utilisation optimale.
  • Le nommage automatique des fichiers n'est pas pris en charge (il faut compter manuellement).
Quand l'utiliser

Utilisez cette compétence lorsque vous devez enregistrer une décision architecturale majeure (choix de framework, base de données, pattern d'intégration) dans le projet.

Quand l'éviter

Évitez de l'utiliser pour des corrections mineures, des améliorations incrémentales ou des décisions qui n'ont pas d'impact architectural durable.

Analyse de sécurité

Sûr
Score qualité90/100

The skill only includes safe bash commands (ls and cp) for listing and copying ADR template files. No destructive, obfuscated, or exfiltrating actions are present.

Aucun point d'attention détecté

Exemples

Create ADR for database choice
Create a new ADR for our decision to adopt PostgreSQL as the primary database for ABIOGENESIS. Use the ADR template from the skill and suggest the next ADR number based on existing records.
Update ADR status to Accepted
Update ADR-002 (Scarlet Setup) status to 'Accepted' and add a 'Last Updated' date of today. Also check the checklist to ensure all sections are filled.
List all ADRs with status
List all Architecture Decision Records in the ABIOGENESIS project and show their statuses in a table.

name: adr description: Create and update Architecture Decision Records for ABIOGENESIS

ADR (Architecture Decision Record) Skill

Purpose

Maintain architectural documentation using the ADR format for significant decisions.

When to Create an ADR

Create an ADR when decisions involve:

  • Framework or tool selection (e.g., Letta adoption)
  • Database or storage choices
  • Integration patterns
  • Major refactoring
  • Technology stack changes

Small fixes and incremental improvements don't need ADRs.

ADR Template

See docs/architecture/adr-template.md for the full template, but use this structure:

# ADR-XXX: Descriptive Title

**Status**: [Proposed | Accepted | Deprecated | Rejected]
**Date**: YYYY-MM-DD
**Author**: Claude Code

## Context
[Why do we need to make this decision?]

## Decision
[What have we decided to do?]

## Consequences
### Positive
- [Benefits]

### Negative
- [Drawbacks]

### Neutral
- [Trade-offs]

## Alternatives Considered
- [Option]: Why rejected

## References
- [Links]

Usage

Create new ADR

# Check next number
ls docs/architecture/adr-*.md | sort

# Copy template
cp docs/architecture/adr-template.md docs/architecture/adr-XXX-title.md

Update Status

When implementing or deprecating:

  1. Open the ADR
  2. Change Status header
  3. Add Last Updated date

ADR Index

| Number | Title | Status | |--------|-------|--------| | ADR-001 | Letta Framework Adoption | Accepted | | ADR-002 | Scarlet Setup (Foundation + Embeddings) | Accepted |

Checklist

  • [ ] Filename: adr-XXX-title.md
  • [ ] Status valid
  • [ ] All sections filled
  • [ ] CHANGELOG.md updated
Skills similaires