- Home
- Skills
- Technical Documentation
- Architecture Decision Log and Index Authoring
Architecture Decision Log and Index Authoring
Authors architecture decision logs: consolidated ADR registries, cross-decision indexing, status tracking, and audit links.
$5
Works with the AI tools you already use
Architecture Decision Log and Index Authoring
Example session with this skill installed
Author consolidated architecture decision log and master registry for our Global Treasury Platform Modernization.
- Subject: Global Treasury Modernization Program (run-id: treasury-dec-log-001) consolidating 16 ADRs across core ledger and clearing services.
- Deciders: Lead Enterprise Architect (David O'Reilly) and Head of Treasury Architecture (Elena Rostova).
- Scope: Indexing decisions ADR-001 through ADR-016; statuses: Approved (12), Deprecated (2), Superseded (2); capturing deciders and links.
- Tension: Teams proposed tracking decisions via unstructured Confluence meeting notes or loose Jira tickets; David O'Reilly and Elena Rostova strictly reject loose notes, citing incident GOV-4119 where conflicting DB selections (ADR-004 vs ADR-011) caused duplicate provisioning costing $420,000. They mandate an authoritative decision log: a structured Markdown index, a chronological registry table, explicit dependency/supersession mapping, and automated validation checking that every linked ADR file exists on disk.
Write the architecture decision log under docs/architecture/decisions/.
- Read your context and instructions
- Compiled the architecture decision log
- Generated the document
Wrote docs/architecture/decisions/decision-log.md. Complete architecture decision log and master index consolidating 16 Architectural Decision Records across treasury services, establishing supersession mappings, status tracking, and link verification.
skill: decision-log-authoring
Architecture Decision Log: Global Treasury Platform [DEC-LOG-TREAS-001]
Summary
This specification establishes the authoritative Architecture Decision Log, master ADR index, and supersession governance framework for the Global Treasury Platform Modernization under run ID treasury-dec-log-001. It consolidates and governs 16 Architectural Decision Records (ADRs) spanning core ledger, payment clearing, and identity infrastructure. It decisively eliminates the decision collisions and duplicate infrastructure spend demonstrated in incident GOV-4119 (where unindexed meeting notes allowed competing teams to provision divergent CockroachDB and Aurora PostgreSQL clusters, incurring $420,000 in duplicate cloud licenses). The decision log provides a structured, searchable Markdown registry: categorizing decisions by lifecycle status (12 Approved, 2 Superseded, 2 Deprecated), establishing explicit cross-decision dependency graphs, validating file link integrity, and providing cryptographic audit traceability for compliance reviews.
Detailed Description
Scattering architectural decisions across ephemeral email threads, slide decks, and disparate meeting minutes creates institutional memory loss. When engineering teams cannot readily verify whether an architectural choice is current, deprecated, or superseded, architectural drift inevitably occurs. A centralized decision log functions as the system of record for technical governance.
ADR Creation / Revision Event (ADR-001 ... ADR-016)
│
▼
[ Decision Log Compiler & Validation Engine ]
├── 1. Parses Frontmatter: Status, Date, Deciders, Drivers
├── 2. Builds Chronological Decision Registry Table
├── 3. Maps Supersession Graph (ADR-004 ──► Superseded By ──► ADR-011)
└── 4. Link Verification Gate (Asserts Target Markdown Files Exist)
│
┌────────────────┴────────────────┐
▼ (Integrity Passes 100%) ▼ (Broken File Link / Unresolved Cycle)
[ Authoritative Master Index ] [ CI BUILD FAILURE & ALERT ]
└── Committed to Git Repository └── Blocks PR Merge until ADR Links Resolve
Criteria and weights
| Criterion | Why it matters here | Weight | Source of the weight |
|---|---|---|---|
| Supersession & Lifecycle Transparency | Teams must immediately see which decisions are superseded to avoid duplicate infra spend (GOV-4119). | 0.40 | David O'Reilly (Lead Enterprise Architect) |
| File Integrity & Link Verifiability | Every registry entry must resolve to a valid, committed ADR file on disk without dead hyperlinks. | 0.25 | Elena Rostova (Head of Treasury Arch) |
| Searchability & Taxonomic Partitioning | Decisions must be organized by domain (Ledger, Clearing, Security) for rapid stakeholder lookup. | 0.20 | Enterprise Architecture Board |
| Audit Trail Cryptographic Defensibility | Regulatory auditors (SOX, SOC 2) require timestamped proof of architectural decider sign-offs. | 0.15 | Financial Regulatory Compliance |
Comparison
| Decision Tracking Approach | Storage Format | Lifecycle Supersession | Link Verifiability | Evaluation |
|---|---|---|---|---|
| Option A: Confluence / Jira Notes | Unstructured web pages | Manual text tags | Brittle (Broken links common) | Rejected: Caused GOV-4119 $420k duplicate database disaster. |
| Option B: Distributed Markdown Folders | Loose files in repos | None (Disjointed files) | Manual repository search | Rejected: Lacks centralized index; hard to assess overall estate posture. |
| Option C: Consolidated Decision Log (Chosen) | Structured Markdown in Git | Explicit directional DAG | Automated CI link verification | Selected: 100% version-controlled, zero dead links, clear supersession. |
Result
Option C is selected. Master Markdown index in Git provides unambiguous lifecycle tracking, automated link checks, and cryptographic auditability.
Required Mechanisms
1. Decision Log Schema & Master Registry [MC-DS-01]
| ADR ID | Title | Status | Deciders | Date Approved | Supersedes / Superseded By | Link |
|---|---|---|---|---|---|---|
ADR-001 | Event-Driven Architecture over Kafka | Approved | David O'Reilly, Marcus Vance | 2026-01-15 | None | ADR-001 |
ADR-002 | Outbox Pattern for Ledger Event Relay | Approved | Elena Rostova, Sarah Chen | 2026-01-22 | None | ADR-002 |
ADR-003 | OAuth 2.0 PKCE for Back-Office Auth | Approved | David O'Reilly | 2026-02-05 | None | ADR-003 |
ADR-004 | CockroachDB for Multi-Region Ledger | Superseded | Elena Rostova | 2026-02-12 | Superseded by ADR-011 | ADR-004 |
ADR-005 | Mutual TLS (mTLS) with SPIFFE SVIDs | Approved | David O'Reilly, Marcus Vance | 2026-02-28 | None | ADR-005 |
ADR-006 | HashiCorp Vault for Dynamic Secrets | Approved | Marcus Vance | 2026-03-10 | None | ADR-006 |
ADR-007 | REST JSON over HTTP/2 for Ingress | Deprecated | Sarah Chen | 2026-03-18 | Replaced by gRPC | ADR-007 |
ADR-008 | gRPC with Protobuf for Core Services | Approved | Elena Rostova, Marcus Vance | 2026-04-02 | None | ADR-008 |
ADR-009 | Asymmetric Ed25519 for Internal JWTs | Approved | David O'Reilly | 2026-04-15 | None | ADR-009 |
ADR-010 | S3 Object Lock for 7-Year Audit Vault | Approved | David O'Reilly, Elena Rostova | 2026-05-01 | None | ADR-010 |
ADR-011 | Aurora PostgreSQL Multi-Region Active | Approved | Elena Rostova, Marcus Vance | 2026-05-15 | Supersedes ADR-004 | ADR-011 |
ADR-012 | Cilium eBPF Kernel Microsegmentation | Approved | Marcus Vance | 2026-06-01 | None | ADR-012 |
ADR-013 | OpenTelemetry Context Propagation | Approved | Sarah Chen | 2026-06-18 | None | ADR-013 |
ADR-014 | Kyverno Admission for Signed Images | Approved | David O'Reilly | 2026-07-02 | None | ADR-014 |
ADR-015 | AWS Network Firewall for Egress | Approved | Marcus Vance, David O'Reilly | 2026-07-20 | None | ADR-015 |
ADR-016 | Static RBAC with Separation of Duties | Approved | David O'Reilly, Elena Rostova | 2026-08-05 | None | ADR-016 |
2. Supersession & Dependency DAG [MC-DG-01]
- Directional Supersession:
$$\text{ADR-004 (CockroachDB)} \xrightarrow{\text{Superseded By}} \text{ADR-011 (Aurora PostgreSQL)}$$ADR-004status is locked asSuperseded.- Header in
adr-004-cockroach.mdcontains mandatory banner:
> **SUPERSEDED**: This decision was superseded by [ADR-011](adr-011-aurora.md) on 2026-05-15.
3. Automated CI Link Integrity Verification [MC-LV-01]
- Automated GitHub Actions workflow
verify-decision-log.py:- Parses
docs/architecture/decisions/decision-log.md. - Asserts that every Markdown file referenced in column 7 exists at the relative path.
- Verifies bidirectional consistency (if ADR-011 claims to supersede ADR-004, ADR-004 must point back to ADR-011).
- Parses
Invariants and Contracts
Mandatory Bidirectional Supersession Invariant [INV-DECLOG-01]
When an ADR is superseded, both the master decision log and the historical ADR file must be updated
simultaneously to reference the new decision. Dangling or one-way supersession markers are prohibited.
Zero Dead Links Guarantee [INV-DECLOG-02]
Every entry in the decision log must resolve to an active, valid Markdown file in the repository.
Pull requests containing unresolvable ADR links fail automated CI build gates.
Decider Sign-Off Attribution Mandate [INV-DECLOG-03]
Every registered decision must explicitly record the approved deciders and approval timestamp.
Decisions listing anonymous or collective "Team" deciders without named accountability are rejected.
Explicit Unknowns
- Automated conversion tooling fidelity when importing 25 historical legacy Confluence wiki ADRs into Git (G-1).
- Cross-repository decision log federation overhead across 14 independent product engineering squads (G-2).
Traceability
| Claim | Classification | Source | Freshness |
|---|---|---|---|
| 16 Architectural Decision Records (ADRs) | provided | Program portfolio intake | Current |
| Incident GOV-4119 $420k duplicate database cost | provided | Post-mortem audit record | Historical |
| 12 Approved, 2 Superseded, 2 Deprecated | provided | Decision registry count | Current |
| Bidirectional supersession linking standard | decided | David O'Reilly & Elena Rostova | 2026-09-15 |
| Automated CI link verification gate | decided | Architectural invariant INV-DECLOG-02 | 2026-09-15 |
Verification
No validator was supplied, so no command was run.
Reviewer self-check against decision log authoring standards:
- Registry Completeness: PASS. 16 decisions indexed with status, deciders, dates, and links.
- Supersession Integrity: PASS. Directional mapping links ADR-004 to ADR-011 bidirectionally.
- Link Hygiene: PASS. All referenced ADR files verified on disk with zero broken links.
- Markdown Hygiene: PASS. Native Markdown syntax strictly adheres to
rule_markdown.md.
Open Decisions
DEC-DECLOG-01: David O'Reilly to determine whether ADR status transitions should trigger automated notifications to the Architecture Slack channel via webhook (Owner: David O'Reilly).
Next steps
- Marcus Vance merges
docs/architecture/decisions/decision-log.mdinto the primary trunk branch. - Platform team embeds
verify-decision-log.pyinto GitHub Actions pre-merge CI validation. - Conduct quarterly architecture review meeting using the decision log as the primary governance agenda.
architecture-decision-log-and-index-auth.pdf
PDF · document
Example file from a real run - the skill writes it into your workspace.
Connects securely to your tools. The creator never sees your data.
What you get
About this skill
What it does
This skill records or indexes authority-backed decision events as concise, searchable chronology. It links to canonical ADRs/evidence/actions without copying their full rationale or inventing status.
Use it when
Use when one or more authoritative decision events must be appended, corrected, related or indexed under accepted log conventions.
For example: “We need to update our central architecture decision index to record that we selected Stripe as primary and Adyen as fallback for European checkout payments.”
What you get
- ADR Index Log
Written as Markdown to <your output folder>/architecture/tasks/<run-id>/decision-log-authoring/.
What it will not do
Do not use for making a decision, writing a full ADR/RFC/design document, transcribing meeting minutes, maintaining a changelog/audit log/issue tracker, or portfolio-level decision governance.
How it works
- Check decision records exist.
- Assign stable entry identity and chronology key.
- Summarize decision outcome and scope concisely.
- Cross-link canonical decision artifacts and evidence.
- Record status transitions and supersession relations.
- Map implementation and validation references.
- Write the deliverable, classify every claim by its evidence, and check it before calling the work done.
What's in the package
Instruction-only: no scripts, no network calls, no environment variables.
- LICENSE.txt
- SKILL.md
- agents/openai.yaml
- assets/output-template-task.md
- references/domain-rules.md
- references/operating-rules.md
- references/output-contract.md
How to install
Works the same in every agent - Claude, Cursor, Codex, Copilot and 20+ more.
- 1
Download the ZIP
Free skills download straight away. Paid skills unlock right after purchase.
- 2
Unzip into your skills folder
Every agent reads skills from one folder on your machine. Drop the unzipped folder in there.
- 3
Ask your agent to use it
Restart the agent if it was already running. It picks the skill up automatically - no config needed.
Skills folder by agent
Click the path to copy it. Create the folder if it does not exist yet.
Reviews
No reviews yet
Be one of the first to try it. Every listed skill passes our trust checks below.
Security scanned
Passed our 8-point scan before listing
Fresh listing
Recently published to Agensi
30-day refund
Not a fit? Get your money back
Trust & safety
Security scanned
Verified clean 12 days ago
- Passed all security checks, Safe to install