|
2 | 2 |
|
3 | 3 | # DevTrail |
4 | 4 |
|
5 | | -**Documentation Governance for AI-Assisted Software Development** |
| 5 | +**AI Governance Platform for Responsible Software Development** |
6 | 6 |
|
7 | 7 | [](LICENSE) |
8 | 8 | [](CONTRIBUTING.md) |
|
22 | 22 |
|
23 | 23 | ## The Problem |
24 | 24 |
|
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: |
26 | 26 |
|
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. |
33 | 30 |
|
34 | 31 | ## The Solution |
35 | 32 |
|
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. |
37 | 34 |
|
38 | | -> **"No significant change without a documented trace."** |
| 35 | +> **"No significant change without a documented trace — and proof of governance."** |
39 | 36 |
|
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. |
41 | 38 |
|
42 | 39 | --- |
43 | 40 |
|
@@ -99,13 +96,15 @@ Built-in safeguards ensure humans stay in control: |
99 | 96 | - **Review triggers**: Low confidence or high risk → mandatory review |
100 | 97 | - **Ethical reviews**: Privacy and bias concerns flagged for human decision |
101 | 98 |
|
102 | | -### ✅ Validation & CI/CD |
| 99 | +### ✅ Compliance Automation |
103 | 100 |
|
104 | | -Automated validation tools: |
| 101 | +Built-in CLI tools for governance: |
105 | 102 |
|
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 |
109 | 108 |
|
110 | 109 | --- |
111 | 110 |
|
@@ -176,7 +175,7 @@ See [CLI Reference](docs/adopters/CLI-REFERENCE.md) for detailed usage. |
176 | 175 | ```bash |
177 | 176 | # Download the latest framework release ZIP from GitHub |
178 | 177 | # 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) |
180 | 179 |
|
181 | 180 | # Extract and copy to your project |
182 | 181 | unzip devtrail-fw-*.zip -d your-project/ |
@@ -230,7 +229,9 @@ Once adopted, DevTrail creates a `.devtrail/` directory in your project for deve |
230 | 229 | ├── 07-ai-audit/ |
231 | 230 | │ ├── agent-logs/ # AILOG documents |
232 | 231 | │ ├── 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 |
234 | 235 | └── templates/ # Document templates |
235 | 236 | ``` |
236 | 237 |
|
@@ -356,6 +357,8 @@ DevTrail includes skills for AI agents that enable **active documentation creati |
356 | 357 | | `/devtrail-ailog` | Quick AILOG creation | ✅ | ✅ | |
357 | 358 | | `/devtrail-aidec` | Quick AIDEC creation | ✅ | ✅ | |
358 | 359 | | `/devtrail-adr` | Quick ADR creation | ✅ | ✅ | |
| 360 | +| `/devtrail-sec` | Security Assessment creation | ✅ | ✅ | |
| 361 | +| `/devtrail-mcard` | Model/System Card creation | ✅ | ✅ | |
359 | 362 |
|
360 | 363 | ### Usage Examples |
361 | 364 |
|
@@ -398,7 +401,7 @@ AI agents report documentation status at the end of each task: |
398 | 401 | | Status | Meaning | |
399 | 402 | |--------|---------| |
400 | 403 | | `DevTrail: Created AILOG-...` | Documentation was created | |
401 | | -| `DevTrail: No documentation required` | Change was minor (<10 lines) | |
| 404 | +| `DevTrail: No documentation required` | Change was minor | |
402 | 405 | | `DevTrail: Documentation pending` | May need manual review | |
403 | 406 |
|
404 | 407 | ### Multi-Agent Architecture |
@@ -460,17 +463,6 @@ All skill implementations are **functionally identical**—only the format diffe |
460 | 463 |
|
461 | 464 | --- |
462 | 465 |
|
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 | | - |
474 | 466 | --- |
475 | 467 |
|
476 | 468 | ## Contributing |
@@ -507,7 +499,7 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file |
507 | 499 |
|
508 | 500 | <div align="center"> |
509 | 501 |
|
510 | | -**DevTrail** — Because every change tells a story. |
| 502 | +**DevTrail** — AI governance, documented. |
511 | 503 |
|
512 | 504 | [⬆ Back to top](#devtrail) |
513 | 505 |
|
|
0 commit comments