Skip to content

Commit 21e03b2

Browse files
montfortclaude
andcommitted
docs: rewrite narrative as AI governance platform, fix version refs, archive evolution
Reposition DevTrail from "documentation helper" to "ISO 42001-aligned AI governance platform" across all user-facing docs. Lead with regulatory urgency (EU AI Act Aug 2026) and compliance value proposition. - README (EN+ES): rewrite Problem/Solution, add compliance automation section, update 12 types + 13 commands, remove duplicate standards section - ADOPTION-GUIDE (EN+ES): add "Why Now?" section, compliance benefits, regulated industries in target users - DEVTRAIL.md: add governance context preamble, C4 Model in standards table - DOCUMENTATION-POLICY (EN+ES): add governance framework preamble, api_spec_path/api_changes fields, bump to v4.0.0 - CLI-REFERENCE (EN+ES): fix all version refs to fw-4.0.0/cli-2.1.0 - CLAUDE.md: fix versions and command list - Archive evolution/ to docs/archive/evolution/ Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent bd68265 commit 21e03b2

13 files changed

Lines changed: 193 additions & 127 deletions

File tree

CLAUDE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ devtrail/
1212
├── cli/ # Rust CLI source code
1313
│ ├── src/
1414
│ │ ├── main.rs # Entry point, command routing
15-
│ │ ├── commands/ # Subcommands: init, update, remove, status, repair, explore, about
15+
│ │ ├── commands/ # Subcommands: init, update, remove, status, repair, validate, compliance, metrics, audit, explore, about
1616
│ │ ├── tui/ # Terminal UI for `explore` (ratatui + crossterm)
1717
│ │ ├── config.rs # DevTrailConfig, Checksums
1818
│ │ ├── download.rs # GitHub API, ZIP downloads
@@ -41,8 +41,8 @@ DevTrail uses **independent versions** for framework and CLI:
4141

4242
| Component | Tag format | Current | Example |
4343
|-----------|-----------|---------|---------|
44-
| Framework | `fw-X.Y.Z` | fw-2.1.0 | `fw-2.1.0` |
45-
| CLI | `cli-X.Y.Z` | cli-1.1.0 | `cli-1.1.0` |
44+
| Framework | `fw-X.Y.Z` | fw-4.0.0 | `fw-4.0.0` |
45+
| CLI | `cli-X.Y.Z` | cli-2.1.0 | `cli-2.1.0` |
4646

4747
Follow [semver](https://semver.org/):
4848
- **Major**: breaking changes

README.md

Lines changed: 23 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# DevTrail
44

5-
**Documentation Governance for AI-Assisted Software Development**
5+
**AI Governance Platform for Responsible Software Development**
66

77
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
88
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
@@ -22,22 +22,19 @@
2222

2323
## The Problem
2424

25-
As AI coding assistants become integral to software development, a critical gap emerges:
25+
As AI becomes integral to software development, organizations face three converging pressures:
2626

27-
- **Who made this change?** Was it a developer or an AI assistant?
28-
- **Why was this decision made?** What alternatives were considered?
29-
- **Should this have been reviewed?** Was human oversight appropriate?
30-
- **What's the impact?** How risky is this change?
31-
32-
Without structured documentation, AI-assisted development becomes a black box.
27+
- **Regulatory compliance**: The EU AI Act becomes mandatory in August 2026. ISO/IEC 42001 is now the international standard for AI governance. Teams need documented evidence.
28+
- **Governance gap**: No structured way to prove that AI decisions are governed, auditable, and compliant — every undocumented AI change is a liability.
29+
- **Operational risk**: Who made this change? What alternatives were considered? Was human oversight appropriate? Without answers, AI-assisted development is a black box.
3330

3431
## The Solution
3532

36-
DevTrail provides a **documentation governance system** that ensures:
33+
DevTrail is an **ISO 42001-aligned AI governance platform** that ensures every meaningful change — whether by human or AI — is documented, attributed, and auditable.
3734

38-
> **"No significant change without a documented trace."**
35+
> **"No significant change without a documented trace — and proof of governance."**
3936
40-
Every meaningful change—whether by human or AI—is documented, attributed, and reviewable.
37+
Teams that adopt DevTrail produce evidence compatible with **ISO/IEC 42001 certification**, **EU AI Act compliance**, and **NIST AI RMF** risk management — while improving development quality and traceability.
4138

4239
---
4340

@@ -99,13 +96,15 @@ Built-in safeguards ensure humans stay in control:
9996
- **Review triggers**: Low confidence or high risk → mandatory review
10097
- **Ethical reviews**: Privacy and bias concerns flagged for human decision
10198

102-
### Validation & CI/CD
99+
### Compliance Automation
103100

104-
Automated validation tools:
101+
Built-in CLI tools for governance:
105102

106-
- **Pre-commit hooks** (Bash) - Validate before commit
107-
- **PowerShell script** - Windows-friendly validation
108-
- **GitHub Actions** - PR validation workflow
103+
- **`devtrail validate`** — 13 validation rules for document correctness
104+
- **`devtrail compliance`** — Regulatory compliance scoring (EU AI Act, ISO 42001, NIST AI RMF)
105+
- **`devtrail metrics`** — Governance KPIs, review rates, risk distribution, trends
106+
- **`devtrail audit`** — Audit trail reports with timeline, traceability maps, and HTML export
107+
- **Pre-commit hooks** + **GitHub Actions** for CI/CD validation
109108

110109
---
111110

@@ -176,7 +175,7 @@ See [CLI Reference](docs/adopters/CLI-REFERENCE.md) for detailed usage.
176175
```bash
177176
# Download the latest framework release ZIP from GitHub
178177
# Go to https://github.com/StrangeDaysTech/devtrail/releases
179-
# and download the latest fw-* release (e.g., fw-2.1.0)
178+
# and download the latest fw-* release (e.g., fw-4.0.0)
180179

181180
# Extract and copy to your project
182181
unzip devtrail-fw-*.zip -d your-project/
@@ -230,7 +229,9 @@ Once adopted, DevTrail creates a `.devtrail/` directory in your project for deve
230229
├── 07-ai-audit/
231230
│ ├── agent-logs/ # AILOG documents
232231
│ ├── decisions/ # AIDEC documents
233-
│ └── ethical-reviews/ # ETH documents
232+
│ └── ethical-reviews/ # ETH, DPIA documents
233+
├── 08-security/ # SEC documents
234+
├── 09-ai-models/ # MCARD documents
234235
└── templates/ # Document templates
235236
```
236237

@@ -356,6 +357,8 @@ DevTrail includes skills for AI agents that enable **active documentation creati
356357
| `/devtrail-ailog` | Quick AILOG creation |||
357358
| `/devtrail-aidec` | Quick AIDEC creation |||
358359
| `/devtrail-adr` | Quick ADR creation |||
360+
| `/devtrail-sec` | Security Assessment creation |||
361+
| `/devtrail-mcard` | Model/System Card creation |||
359362

360363
### Usage Examples
361364

@@ -398,7 +401,7 @@ AI agents report documentation status at the end of each task:
398401
| Status | Meaning |
399402
|--------|---------|
400403
| `DevTrail: Created AILOG-...` | Documentation was created |
401-
| `DevTrail: No documentation required` | Change was minor (<10 lines) |
404+
| `DevTrail: No documentation required` | Change was minor |
402405
| `DevTrail: Documentation pending` | May need manual review |
403406

404407
### Multi-Agent Architecture
@@ -460,17 +463,6 @@ All skill implementations are **functionally identical**—only the format diffe
460463

461464
---
462465

463-
## Standards Alignment
464-
465-
DevTrail aligns with:
466-
467-
- **ADR** (Architecture Decision Records) - Native support
468-
- **IEEE 830** - Requirements documentation structure
469-
- **ISO/IEC 25010** - Quality attributes in ADRs
470-
- **GDPR** - Privacy impact documentation (ETH)
471-
- **EU AI Act** - AI transparency and human oversight
472-
- **NIST AI RMF** - Risk documentation
473-
474466
---
475467

476468
## Contributing
@@ -507,7 +499,7 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
507499

508500
<div align="center">
509501

510-
**DevTrail**Because every change tells a story.
502+
**DevTrail**AI governance, documented.
511503

512504
[⬆ Back to top](#devtrail)
513505

dist/.devtrail/00-governance/DOCUMENTATION-POLICY.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Documentation Policy - DevTrail
22

3+
## Governance Framework
4+
5+
This policy aligns DevTrail documentation with **ISO/IEC 42001:2023** (vertebral standard for AI Management Systems) and operationalizes:
6+
7+
- **EU AI Act** (effective August 2026) — risk classification, transparency, incident reporting
8+
- **NIST AI RMF 1.0 + AI 600-1** — AI risk management functions and generative AI profiles
9+
- **ISO/IEC 23894:2023** — AI risk management framework
10+
- **GDPR** — data protection and privacy impact assessments
11+
12+
All document types, metadata fields, and governance rules contribute to evidence that satisfies these regulatory frameworks. See Section 8 for the complete standards reference.
13+
314
---
415

516
## 1. File Naming Convention
@@ -80,6 +91,8 @@ related:
8091
| `lines_changed` | Lines changed count (auto-calculable) | In AILOG documents |
8192
| `files_modified` | List of modified files (auto-calculable) | In AILOG documents |
8293
| `observability_scope` | OTel instrumentation level: `none \| basic \| full` | When the change involves observability instrumentation |
94+
| `api_spec_path` | Path to OpenAPI/AsyncAPI specification file | In REQ documents when the requirement involves API interfaces |
95+
| `api_changes` | List of API endpoints affected | In ADR documents when the decision modifies public APIs |
8396

8497
### Tags Convention
8598

@@ -234,4 +247,4 @@ See also [ADR-2025-01-20-001] for architectural context.
234247

235248
---
236249

237-
*DevTrail v3.0.0 | [Strange Days Tech](https://strangedays.tech)*
250+
*DevTrail v4.0.0 | [Strange Days Tech](https://strangedays.tech)*

dist/.devtrail/00-governance/i18n/es/DOCUMENTATION-POLICY.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@
22

33
**Idiomas**: [English](../../DOCUMENTATION-POLICY.md) | Español
44

5+
## Marco de Gobernanza
6+
7+
Esta política alinea la documentación de DevTrail con **ISO/IEC 42001:2023** (estándar vertebral para Sistemas de Gestión de IA) y operacionaliza:
8+
9+
- **EU AI Act** (efectivo agosto 2026) — clasificación de riesgo, transparencia, reporte de incidentes
10+
- **NIST AI RMF 1.0 + AI 600-1** — funciones de gestión de riesgos de IA y perfiles de IA generativa
11+
- **ISO/IEC 23894:2023** — marco de gestión de riesgos de IA
12+
- **GDPR** — evaluaciones de impacto en protección de datos y privacidad
13+
14+
Todos los tipos de documentos, campos de metadatos y reglas de gobernanza contribuyen a evidencia que satisface estos marcos regulatorios. Ver Sección 8 para la referencia completa de estándares.
15+
516
---
617

718
## 1. Convención de Nomenclatura de Archivos
@@ -82,6 +93,8 @@ related:
8293
| `lines_changed` | Conteo de líneas cambiadas (auto-calculable) | En documentos AILOG |
8394
| `files_modified` | Lista de archivos modificados (auto-calculable) | En documentos AILOG |
8495
| `observability_scope` | Nivel de instrumentación OTel: `none \| basic \| full` | Cuando el cambio involucra instrumentación de observabilidad |
96+
| `api_spec_path` | Ruta al archivo de especificación OpenAPI/AsyncAPI | En documentos REQ cuando el requisito involucra interfaces de API |
97+
| `api_changes` | Lista de endpoints de API afectados | En documentos ADR cuando la decisión modifica APIs públicas |
8598

8699
### Convención de Tags
87100

@@ -236,4 +249,4 @@ Ver también [ADR-2025-01-20-001] para contexto arquitectónico.
236249

237250
---
238251

239-
*DevTrail v3.0.0 | [Strange Days Tech](https://strangedays.tech)*
252+
*DevTrail v4.0.0 | [Strange Days Tech](https://strangedays.tech)*

dist/.devtrail/QUICK-REFERENCE.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# DevTrail - Quick Reference
22

33
> One-page reference for AI agents and developers.
4+
>
5+
> **This is a simplified reference** — see `00-governance/QUICK-REFERENCE.md` for the complete version,
6+
> or `00-governance/DOCUMENTATION-POLICY.md` for the authoritative source.
47
58
---
69

@@ -157,12 +160,12 @@ Mark `review_required: true` when:
157160

158161
| I just... | Create |
159162
|-----------|--------|
160-
| Implemented >10 lines | AILOG |
163+
| Implemented >20 lines | AILOG |
161164
| Chose between options | AIDEC |
162165
| Fixed security issue | AILOG + `risk_level: high` |
163166
| Found tech debt | TDE |
164167
| Handled PII data | AILOG + ETH |
165168

166169
---
167170

168-
*DevTrail | [GitHub](https://github.com/StrangeDaysTech/devtrail) | [Strange Days Tech](https://strangedays.tech)*
171+
*DevTrail v4.0.0 | [GitHub](https://github.com/StrangeDaysTech/devtrail) | [Strange Days Tech](https://strangedays.tech)*

dist/DEVTRAIL.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,18 @@
66
77
---
88

9+
## Governance Context
10+
11+
These rules operationalize **ISO/IEC 42001:2023** (AI Management System) — DevTrail's vertebral standard. Following them produces documented evidence compatible with:
12+
13+
- **EU AI Act** (Regulation 2024/1689) — risk classification, transparency, incident reporting
14+
- **NIST AI RMF 1.0 + 600-1** — risk management functions and generative AI risk profiles
15+
- **GDPR** — data protection impact assessments and privacy safeguards
16+
17+
> See `AI-GOVERNANCE-POLICY.md` for the full ISO 42001 Annex A control mapping.
18+
19+
---
20+
921
## 1. Fundamental Principle
1022

1123
> **"No significant change without a documented trace."**
@@ -317,6 +329,7 @@ DevTrail is aligned with the following standards and regulations:
317329
| **ISO/IEC/IEEE 29119-3:2021** | Software testing documentation | TES |
318330
| **GDPR** | Data protection and privacy | ETH (Data Privacy) |
319331
| **OpenTelemetry** | Observability (optional, complementary) | Tag `observabilidad` |
332+
| **C4 Model** | Architecture visualization in ADR documents | ADR (Mermaid diagrams) |
320333

321334
> **Reference**: See `AI-GOVERNANCE-POLICY.md` for the full ISO 42001 Annex A mapping to DevTrail documents.
322335

docs/adopters/ADOPTION-GUIDE.md

Lines changed: 35 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -24,37 +24,44 @@
2424

2525
## What is DevTrail?
2626

27-
DevTrail is a **documentation governance system** designed for software development projects that utilize AI coding assistants. It provides:
27+
DevTrail is an **ISO 42001-aligned AI governance platform** for software development teams. It provides:
2828

29-
- **Structured documentation** for decisions, actions, and changes
30-
- **AI agent accountability** through mandatory identification and confidence tracking
31-
- **Human oversight** via required review workflows for critical changes
32-
- **Traceability** connecting requirements → design → implementation → testing
29+
- **12 structured document types** covering the full development and AI lifecycle
30+
- **Regulatory compliance automation** — EU AI Act, ISO 42001, NIST AI RMF scoring and audit trails
31+
- **AI agent accountability** through mandatory identification, confidence tracking, and autonomy limits
32+
- **Human oversight** via required review workflows for critical and high-risk changes
33+
- **Traceability** connecting requirements → design → implementation → testing → incidents
3334

3435
### Core Principle
3536

36-
> **"No significant change without a documented trace."**
37+
> **"No significant change without a documented trace — and proof of governance."**
3738
38-
DevTrail ensures that every meaningful change in your codebase is documented, attributed, and reviewable—whether made by a human developer or an AI assistant.
39+
DevTrail ensures that every meaningful change — whether by human or AI — is documented, attributed, and auditable. Teams that adopt DevTrail produce evidence compatible with **ISO/IEC 42001 certification** and **EU AI Act compliance**.
40+
41+
### Why Now?
42+
43+
The **EU AI Act becomes mandatory in August 2026**. ISO/IEC 42001 is the international standard for AI Management Systems. Organizations using AI in development need documented governance — not as a nice-to-have, but as a regulatory requirement. DevTrail operationalizes these requirements from day one.
3944

4045
### What DevTrail is NOT
4146

42-
- ❌ A documentation generator (it provides structure, not content generation)
43-
- ❌ A replacement for code comments or API docs
44-
- ❌ A project management tool
45-
- ❌ A version control system
47+
- It is not a documentation generator it provides structure, templates, and governance rules
48+
- It is not a replacement for code comments or API docs
49+
- It is not a project management tool or version control system
50+
- It is not a full ISO 42001 implementation — it produces compatible evidence within its scope
4651

4752
---
4853

4954
## Who is it for?
5055

5156
### Target Users
5257

53-
| User Type | Use Case |
54-
|-----------|----------|
55-
| **Solo Developers** | Track your own decisions and AI-assisted changes |
56-
| **Small Teams** | Maintain consistency across team members and AI tools |
57-
| **Enterprise Teams** | Audit trails, compliance, governance at scale |
58+
| User Type | Adoption Drivers |
59+
|-----------|-----------------|
60+
| **Teams using AI coding assistants** | Prove governance for regulatory audits and quality assurance |
61+
| **High-risk AI systems** | EU AI Act mandates documented risk management and transparency |
62+
| **Organizations seeking ISO 42001** | DevTrail produces certification-ready evidence |
63+
| **Regulated industries** (finance, healthcare, EU-based) | Regulatory compliance mandatory by August 2026 |
64+
| **Solo Developers** | Track decisions and AI-assisted changes with structure |
5865
| **Open Source Maintainers** | Document contribution decisions transparently |
5966

6067
### Compatible Development Environments
@@ -85,6 +92,16 @@ DevTrail works with any development methodology:
8592

8693
## Benefits
8794

95+
### For Regulatory Compliance
96+
97+
| Benefit | Description |
98+
|---------|-------------|
99+
| **EU AI Act Ready** | Risk classification, incident reporting, and transparency templates built in |
100+
| **ISO 42001 Compatible** | Documentation structure aligns with certification audit requirements |
101+
| **NIST AI RMF Mapped** | 12 GenAI risk categories and governance functions explicitly covered |
102+
| **Audit Trail Complete** | `devtrail audit` generates exportable timeline and traceability reports |
103+
| **Compliance Scoring** | `devtrail compliance` provides percentage-based regulatory gap analysis |
104+
88105
### For Development Teams
89106

90107
| Benefit | Description |
@@ -100,17 +117,8 @@ DevTrail works with any development methodology:
100117
|---------|-------------|
101118
| **AI Transparency** | Every AI action is logged with confidence levels |
102119
| **Human Oversight** | Critical decisions require human approval |
103-
| **Ethical Safeguards** | ETH documents ensure responsible AI use |
104-
| **Audit Trail** | Complete history of AI contributions |
105-
106-
### For Organizations
107-
108-
| Benefit | Description |
109-
|---------|-------------|
110-
| **Compliance Ready** | Documentation structure supports regulatory requirements |
111-
| **Risk Management** | Risk levels flag high-impact changes |
112-
| **Knowledge Retention** | Documentation survives personnel changes |
113-
| **Quality Assurance** | Structured review processes |
120+
| **Ethical Safeguards** | ETH and DPIA documents ensure responsible AI use |
121+
| **Governance Metrics** | `devtrail metrics` tracks review rates, risk distribution, and trends |
114122

115123
---
116124

0 commit comments

Comments
 (0)