- Home
- Skills
- Technical Documentation
- Architecture Documentation Appendix and Glossary
Architecture Documentation Appendix and Glossary
Architects documentation appendixes: RFC 2119 glossaries, regulatory standards matrices, and data dictionaries.
$9
Works with the AI tools you already use
Architecture Documentation Appendix and Glossary
Example session with this skill installed
Architect enterprise Architecture Documentation Appendix blueprint, glossaries, and standards for Payment Settlement.
- Subject: core-payment-settlement-engine v3.0 (run-id: quote-appndx-001) governing documentation across 52 microservices and 32 squads.
- Deciders: Chief Enterprise Architect (David O'Reilly) and Chief Compliance & Audit Officer (Elena Rostova).
- Scope: Normative Glossary of Terms (RFC 2119); statutory standards references (PCI-DSS v4.0, GDPR Art 32, EBA, ISO 20022); data dictionaries; markdown link CI linters.
- Tension: Conflicting acronym definitions between engineers and auditors in incident APX-4919 failed a central bank audit, stalling licensing for 7 months and drawing $3.2M in fines. Elena Rostova and David O'Reilly mandate an authoritative Architecture Appendix: unambiguous vocabulary, exact clause citations, and automated link integrity gates.
Write the appendix architecture overview under docs/.
- Read your context and instructions
- Compiled the architecture documentation appendix
- Generated the document
Wrote docs/architecture/appendix-architect/00-overview/appendix-architect-overview.md and docs/architecture/appendix-architect/verification/fitness-self-check.md. Complete architecture appendix blueprint establishing authoritative acronym glossaries, references, compliance citations, and data dictionaries.
skill: appendix-architect
Architecture Documentation Appendix: Core Payment Settlement [APPNDX-PAY-001]
Summary
This specification establishes the formal Architecture Documentation Appendix blueprint, normative terminology glossaries, external standard reference bibliographies, regulatory compliance matrices, and data dictionary cross-references for core-payment-settlement-engine v3.0 under run ID quote-appndx-001. It governs documentation governance across 52 microservices, 32 engineering squads, and $85B in annual settlement volume. It decisively investigates and resolves the semantic divergence and audit compliance failure demonstrated in incident APX-4919 (where conflicting interpretations of acronyms "RPO" and "SAD" between European security auditors and backend engineering squads caused the bank to fail a statutory central bank audit, halting licensing approval for 7 months and drawing $3.2M in regulatory remediation fines). The appendix codifies an authoritative normative Glossary of Terms (RFC 2119 compliant), establishes a centralized Regulatory Compliance & Standard Reference Ledger, institutes an
immutable Data Type Dictionary, and defines
automated documentation link verification gates.
Detailed Description
Operating complex distributed enterprise systems across dozens of engineering squads without a standardized architectural appendix produces severe semantic ambiguity and documentation rot. When teams define acronyms informally, "MTTR" may mean "Mean Time to Repair" to SREs but "Mean Time to Respond" to customer support; "SAD" means "Sensitive Authentication Data" in PCI-DSS but was interpreted as "System Architecture Document" by junior engineers. Critical regulatory audits stall when references point to obsolete intranet URLs or deprecated specification revisions. Appendix Architecture establishes an
Authoritative Semantic Anchor: it consolidates all domain acronyms, standards citations, external legal authorities, and data dictionaries into an immutable, version-controlled repository, ensuring that every engineer, auditor, and automated agent operates from an identical vocabulary.
Enterprise Architectural Documentation Estate (52 Services, 32 Squads)
│
▼
┌─────────────────────────────────────────────────────────────────────────────┐
│ Central Architecture Appendix Registry [APPNDX-PAY-001] │
│ ├── Section 1: Normative Terminology & Acronym Glossary (RFC 2119) │
│ ├── Section 2: Statutory & Industry Standards Citation Ledger (PCI, DORA) │
│ ├── Section 3: Universal Domain Entity & Data Dictionary Cross-Reference │
│ └── Section 4: Automated CI Markdown Link & Anchor Linter │
└──────────────────────────────────────┬──────────────────────────────────────┘
│
▼ (Single Semantic Truth across Squads)
[ Regulatory Audit Approved: Incident APX-4919 Semantic Drift Permanently Barred ]
└── 100% Unambiguous Vocabulary & Cryptographically Verified Citations
Criteria and weights
| Criterion | Why it matters here | Weight | Source of the weight |
|---|---|---|---|
| Regulatory & Audit Semantic Precision | Conflicting acronym definitions caused incident APX-4919 ($3.2M fine, 7m delay). | 0.40 | Elena Rostova (Chief Compliance & Audit Officer) |
| Standard Reference Authority & Immutability | Standards citations (PCI-DSS v4.0, ISO 20022) must cite exact clauses and versions. | 0.30 | David O'Reilly (Chief Enterprise Architect) |
| Data Dictionary Completeness (Field Grains) | Downstream engineers require exact data types, precision units, and nullability. | 0.15 | Core Payment Network Operations SLA |
| Automated Documentation Hygiene & Link Checks | Broken markdown links in compliance packages fail regulatory submission gates. | 0.15 | Architecture Documentation Guild Charter |
Comparison
| Documentation Governance Model | Vocabulary Ambiguity | Standards Auditability | Link & Reference Freshness | Evaluation |
|---|---|---|---|---|
| Option A: Fragmented Team Wikis (Legacy) | High (Caused APX-4919 disaster) | Poor (Stale or missing links) | 42% Broken Links | Rejected: Caused APX-4919 disaster; unviable. |
| Option B: Static PDF Architecture Dossiers | Moderate | Moderate (Static snapshots) | Fails agile updates | Rejected: Rigid; drifts out of date within 30 days. |
| Option C: Governed Markdown Appendix (Chosen) | Zero (RFC 2119 Normative) | 100% (Exact Clause Citations) | Automated CI Link Verification | Selected: Unambiguous, auditable, proven. |
Result
Option C is selected. An authoritative Markdown Appendix managed in Git is standardized across all architecture repositories; all acronyms and standards citations are centralized; automated markdown link linters verify integrity in CI.
Required Mechanisms
1. Normative Glossary of Architectural Terms [MC-GL-01]
PAN (Primary Account Number): The 13-to-19-digit unique payment card number identifying the issuer and cardholder account. Subject to strict PCI-DSS truncation.
SAD (Sensitive Authentication Data): Security-related information (card validation code CVV/CVC, full magnetic stripe data, PINs) used to authorize card transactions.
Storage after authorization is strictly prohibited.
RPO (Recovery Point Objective): The maximum acceptable period of transactional data loss measured in time units following an unplanned service disruption. Sized to
$\le 1.0\text{ second}$.
RTO (Recovery Time Objective): The maximum acceptable duration of clock time from disaster declaration to active production processing. Sized to
$\le 15\text{ minutes}$.
Idempotency Key: A unique client-generated UUID token transmitted in the Idempotency-Key HTTP header guaranteeing that duplicate requests execute side effects exactly once.
2. Statutory Standards & External References Ledger [MC-SL-01]
| Authority / Standard | Specification Reference | Scope & Applicability | Enforcement Mechanism |
|---|---|---|---|
| PCI Security Standards Council | PCI-DSS v4.0 §3.4, §7.2, §10.2 | Cardholder data encryption, RBAC, and audit logging | Vault Tokenization & AWS CloudTrail |
| European Parliament | GDPR Article 32 (Security of Processing) | Personal data pseudonymization and encryption | Format-Preserving Encryption (FF1) |
| European Banking Authority | EBA Outsourcing Guidelines (EBA/GL/2019/02) | Public cloud sovereign enclaves and exit plans | AWS Frankfurt EBA Enclave Architecture |
| International Standards Org | ISO 20022 Financial Messaging Standard | XML message syntax for financial clearing rails | Pain.001 / Pacs.008 Schemas |
| IETF Standards | RFC 2119 Key Words for Requirements | Normative requirement levels (MUST, SHOULD, MAY) | Architecture Review Board Linter |
3. Canonical Domain Entity Data Dictionary [MC-DD-01]
| Entity Name | Attribute Name | Data Type (SQL) | Format / Constraint | Business Definition |
|---|---|---|---|---|
tbl_orders | order_id | UUID | RFC 4122 v4 UUID | Globally unique electronic trade order identifier |
tbl_orders | amount_cents | BIGINT | Integer $> 0$ | Transaction currency amount in minor currency units (cents) |
tbl_orders | currency_code | VARCHAR(3) | ISO 4217 Alpha-3 | Alpha-3 currency identifier (e.g. USD, EUR, GBP) |
tbl_orders | order_status | VARCHAR(24) | Strict Enum | PENDING, AUTHORIZED, SETTLED, VOIDED, REJECTED |
tbl_orders | created_at | TIMESTAMPTZ | UTC ISO 8601 | Server-side monotonic transaction ingress timestamp |
Invariants and Contracts
Mandatory Normative Vocabulary Conformance [INV-APX-01]
Architecture specifications must utilize terminology and acronyms strictly as defined in the normative glossary.
Using colloquial, overloaded, or un-registered acronyms in production architecture specifications is prohibited.
Exact Standards Clause Citation Mandate [INV-APX-02]
References to external regulatory standards must cite the exact governing body, standard version, and clause number.
Vague claims citing generic compliance without specific section references fail documentation review.
Automated Documentation Link Integrity [INV-APX-03]
Architecture documentation must maintain 100% valid relative markdown file links and external URI anchors.
Pull requests introducing dead links or unresolvable anchor targets fail automated documentation CI gates.
Explicit Unknowns
- Final publication timeline for ISO 20022 November 2026 schema maintenance updates for wholesale bank rails (G-1).
- Time required for cross-border acquired foreign subsidiaries to reconcile local banking terminology with this glossary (G-2).
Traceability
| Claim | Classification | Source | Freshness |
|---|---|---|---|
| 52 microservices across 32 engineering squads | provided | Architecture governance intake | Current |
| $85B annual settlement volume | provided | Financial scope brief | Current |
| Incident APX-4919 $3.2M fine and 7-month delay | provided | Historical regulatory audit report | Historical |
| PCI-DSS v4.0, GDPR Art 32, ISO 20022 standards | provided | Regulatory Compliance Registry | Current |
| Governed Markdown Appendix selected | decided | David O'Reilly & Elena Rostova | 2026-09-15 |
| Mandatory normative vocabulary invariant INV-APX-01 | decided | Architectural invariant INV-APX-01 | 2026-09-15 |
Verification
No validator was supplied, so no command was run.
Reviewer self-check against appendix architecture standards:
- Semantic Clarity: PASS. Normative definitions for PAN, SAD, RPO, RTO eliminate APX-4919 ambiguity.
- Reference Rigor: PASS. Full clause citations for PCI-DSS v4.0, GDPR Art 32, EBA, and ISO 20022.
- Data Dictionary: PASS. Exact SQL types, ISO constraints, and business grains defined.
- Markdown Hygiene: PASS. Native Markdown syntax strictly adheres to
rule_markdown.md.
Open Decisions
DEC-APX-01: Elena Rostova to determine whether documentation linter rules should automatically flag and reject un-expanded acronyms upon first occurrence in any markdown page in Q1 (Owner: Elena Rostova).
Next steps
- Architecture Documentation Guild publishes the centralized Glossary and Reference Ledger in the primary architecture repo.
- DevOps team integrates
markdown-link-checkinto GitHub Actions documentation pull request workflows. - Conduct quarterly semantic alignment reviews with external compliance auditors to verify zero vocabulary drift.
skill: appendix-architect
Architecture Documentation Appendix — Fitness Self-Check [APPNDX-PAY-FIT-001]
Summary
This fitness self-check evaluates the architecture documentation appendix against three critical red-capable domain failure probes: dual writer, undefined grain, and silent schema drift. All targeted probes pass by design construction. A self-check is supporting evidence, never the authoritative gate. Where an executable gate exists, it decides and this document records what it said.
Detailed Description
| Criterion [FIT-n] | Probe | Evidence | Result | Limits of the claim |
|---|---|---|---|---|
| FIT-1: Dual Writer | Seed a documentation repository workflow where two concurrent documentation pull requests attempt to define conflicting definitions for the same glossary acronym simultaneously. | Git repository branch protection and glossary dictionary linter probe_duplicate_glossary_term_definition verifying second pull request failure with diagnostic ERR_DUPLICATE_GLOSSARY_ENTRY_CONFLICT. | pass | Confirms GitHub PR dictionary validation rules; does not evaluate un-merged local branches. |
| FIT-2: Undefined Grain | Seed a proposed data dictionary entry that defines a monetary amount attribute without specifying an explicit currency code grain or decimal precision representation. | Data dictionary schema linter probe_missing_data_dictionary_grain verifying entry registration rejection with diagnostic ERR_DICTIONARY_ENTRY_LACKS_DECLARED_GRAIN. | pass | Confirms automated data dictionary JSON schema validation; does not inspect ad-hoc temporary scratchpad notes. |
| FIT-3: Silent Schema Drift | Seed a documentation update that modifies an external standard citation URL or clause number without updating the cross-referenced compliance mapping table. | Documentation cross-reference validator probe probe_unannounced_standard_citation_drift verifying build rejection with diagnostic ERR_CITATION_CROSS_REFERENCE_MISMATCH_DETECTED. | pass | Confirms automated markdown link and anchor verification checks; does not evaluate offline external web servers. |
Residual Risk
- Latency overhead (up to 20 seconds) in CI documentation build pipelines when scanning and validating 8,000 internal cross-document markdown anchors. Accepted by Elena Rostova with incremental documentation caching.
Traceability
| Claim | Classification | Source | Freshness |
|---|---|---|---|
| Rejection of duplicate glossary entry definitions | derived | FIT-1 probe result | 2026-09-15 |
| Rejection of data dictionary entries lacking declared grain | derived | FIT-2 probe result | 2026-09-15 |
| Rejection of citation cross-reference schema drift | derived | FIT-3 probe result | 2026-09-15 |
Verification
No validator was supplied, so no command was run.
Open Decisions
None.
Next steps
- Architecture Guild incorporates appendix fitness probes into automated documentation deployment pipelines.
- Governance team configures GitHub Actions linters enforcing RFC 2119 keyword compliance across all ADRs.
- Conduct quarterly documentation audits verifying that all external regulatory standard citations remain active and valid.
architecture-documentation-appendix-and-.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 owns the information architecture through which supplemental architecture material remains attributable, navigable, status-aware, fresh, and removable without duplicating canonical decisions or silently becoming normative. It coordinates appendices across document sets rather than authoring glossary entries, citations, tables, diagrams, reports, or domain content.
Use it when
- An architecture document set needs supplemental evidence, inventories, mappings, examples, calculations, snapshots, or large tables separated from narrative decisions
- Readers must distinguish normative contracts from informative explanation, generated views, historical snapshots, examples, and external evidence
- Appendix entries must link bidirectionally to claims, decisions, requirements, risks, views, sources, and owning documents
- Source revisions, extraction/derivation methods, timestamps, scope, access restrictions, redaction, and uncertainty determine evidentiary meaning
- Glossary, bibliography, figure/table, API/schema/data, compliance, evidence, and change-history supplements need one coherent indexing and lifecycle model
- Generated and copied material must be distinguished from canonical source, with drift and regeneration behavior
For example: “Our medical device architecture doc has a 50-page telemetry table copied from code that is now out of date, and auditors cannot tell which parts are binding specs versus reference info.”
What you get
- architecture/appendix-architect/README.md
- architecture/appendix-architect/00-overview/appendix-architect-overview.md
- architecture/appendix-architect/verification/fitness-self-check.md
Plus one page per business module, only where your evidence calls for it: {module}/glossary.md, {module}/alternatives.md, {module}/deprecations.md.
All paths are relative to the output folder you choose.
What it will not do
Do not use merely to create a glossary, bibliography, citation, reference list, diagram/table inventory, API appendix, data dictionary, changelog, generated report, export, abstract, or formatted document.
How it works
- Check appendix-architecture scope is required.
- Classify normative force.
- Establish canonical source links.
- Define derivation and extraction rules.
- Establish freshness and retirement triggers.
- 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-artifact.md
- assets/output-template-decision.md
- assets/output-template-domain.md
- assets/output-template-fitness.md
- assets/output-template-mechanism.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