Files
acdl/modules/README-TEMPLATE.md
T
Jon Chery 2682719f24
acdl-ci / Lint (push) Successful in 7s
acdl-ci / Test (push) Successful in 26s
acdl-ci / Platform check-only (offline) (push) Successful in 8s
docs(P47): presentation slide updates + HIPAA removal from all docs
Presentation changes (both Marp decks + source markdown):
1. Title slide: deck title as H1 (slightly bigger), 'Agentic Cloud Delivery
   Platform' as H3 subtitle — cleaner title hierarchy
2. DX deck: removed Local Reproducibility slide (not beneficial for DX)
3. DX deck: Safe Promotion Path slide redesigned with side-by-side layout
   for Approaches A and B (HTML table, two columns)
4. DX deck: 'an agent' → 'an AI agent' (slide 2 + Citizen Developer slide)
5. DX deck: What a Developer Does — diagram floated to the right side
6. Header simplified to just the deck name (subtitle now on title slide)

HIPAA removal (25 files):
- Completely removed all HIPAA references from all markdown documentation,
  presentation source files, module READMEs, and rendered HTML
- Removed HIPAA from compliance milestone lists (GDPR, SOX, SOC2, DORA remain)
- Removed HIPAA section references (§164.xxx) from compliance annotations
- Cleaned up empty parentheses and broken commas left by removal
- Re-rendered both HTML decks from updated Marp source

---ci---
phase: 47
milestone: v1.9
status: complete
requirements:
  covered: []
  partial: []
---/ci---
2026-07-23 14:08:40 +00:00

62 lines
1.9 KiB
Markdown

# <module-name> — <plain-language description>
> **Module kind:** primitive | **Version:** 1.0.0
## Overview
One or two sentences describing what this module provisions, in plain
language. No jargon. A reader should know after this paragraph whether
this module is what they need.
## Resources
Terraform resources this module creates:
| Resource | Type | Purpose |
|----------|------|---------|
| `<name>` | `aws_<type>` | what it does |
## Inputs
| Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `<name>` | string | yes | — | description |
## Outputs
| Name | Type | Description |
|------|------|-------------|
| `<name>` | string | description |
## NFRs
Non-functional requirements declared by the module's interface. Every
L1 primitive MUST declare `deletion_protection` and `encryption_enabled`
(both boolean, default `true`); they are mandatory NFRs for every L1.
| Name | Type | Default | Description |
|------|------|---------|-------------|
| `deletion_protection` | boolean | true | Prevent resource destruction via Terraform lifecycle prevent_destroy. |
| `encryption_enabled` | boolean | true | Enable encryption (at rest or in transit, as applicable). |
| `<name>` | <type> | <default> | description |
## Usage
```
# A concrete snippet showing how to reference this module or what a
# consumer writes to use it.
```
## Compliance extension points
Resources this module could be extended with for the future compliance
milestone (GDPR, SOX, SOC2, DORA). Not implemented yet — listed
so the redesign can plan for them.
- **<area>** — <what could be added, e.g. KMS key for encryption>
## Versioning
`1.0.0` — interface MAJOR, behavior MINOR, lifecycle PATCH. MAJOR
bumps require a new registry entry (immutable publication); old entries
enter a 12-month deprecation window.