@ghostbyte/agent-docs-kit 4.0.2 → 5.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (120) hide show
  1. package/CHANGELOG.md +32 -0
  2. package/README.md +43 -37
  3. package/SECURITY.md +11 -0
  4. package/content/catalog.json +191 -22
  5. package/content/documentation/01-system-documentation.md +13 -0
  6. package/content/documentation/02-project-governance.md +13 -0
  7. package/content/documentation/03-development-records.md +13 -0
  8. package/content/documentation/04-testing-evidence.md +13 -0
  9. package/content/documentation/05-operations-runbooks.md +13 -0
  10. package/content/documentation/06-future-proposals.md +13 -0
  11. package/content/documentation/07-archive-governance.md +13 -0
  12. package/content/documentation/full-reference.md +24 -0
  13. package/content/engineering/01-query-performance.md +17 -27
  14. package/content/engineering/02-networking-fundamentals.md +17 -27
  15. package/content/engineering/03-rate-limiting-algorithms.md +18 -28
  16. package/content/engineering/04-production-debugging.md +17 -27
  17. package/content/engineering/05-code-review-practices.md +17 -27
  18. package/content/engineering/06-data-modeling.md +17 -27
  19. package/content/engineering/07-cloud-cost-saving.md +17 -27
  20. package/content/engineering/08-testing-types.md +17 -27
  21. package/content/engineering/09-message-queues.md +17 -27
  22. package/content/engineering/10-api-design-compatibility.md +14 -0
  23. package/content/engineering/11-reliability-slos.md +14 -0
  24. package/content/engineering/12-observability-telemetry.md +14 -0
  25. package/content/engineering/13-deployment-change-safety.md +14 -0
  26. package/content/engineering/14-capacity-concurrency.md +14 -0
  27. package/content/engineering/full-reference.md +24 -144
  28. package/content/security/01-design-architecture.md +11 -19
  29. package/content/security/02-local-development.md +13 -21
  30. package/content/security/03-database-backend.md +18 -26
  31. package/content/security/04-api-layer.md +23 -31
  32. package/content/security/05-frontend-ui.md +16 -24
  33. package/content/security/06-application-security-testing.md +22 -28
  34. package/content/security/07-cicd-release-engineering.md +13 -21
  35. package/content/security/08-cloud-infrastructure.md +17 -25
  36. package/content/security/09-edge-cdn-dns.md +16 -24
  37. package/content/security/10-release-rollout.md +13 -21
  38. package/content/security/11-post-release-monitoring-ir.md +15 -23
  39. package/content/security/12-ongoing-operations.md +24 -32
  40. package/content/security/full-reference.md +30 -3163
  41. package/docs/ARCHITECTURE.md +31 -92
  42. package/docs/CONTENT_MAINTENANCE.md +5 -1
  43. package/docs/GITHUB_AND_NPM_SETUP.md +1 -1
  44. package/docs/RELEASE_PROCESS.md +5 -5
  45. package/package.json +12 -5
  46. package/scripts/build-site.mjs +13 -0
  47. package/scripts/build-skill.mjs +24 -0
  48. package/scripts/check-links.mjs +56 -0
  49. package/scripts/check-review-dates.mjs +21 -0
  50. package/scripts/preview-site.mjs +43 -0
  51. package/scripts/smoke-package.mjs +58 -0
  52. package/scripts/validate-content.mjs +85 -0
  53. package/site/app.js +121 -0
  54. package/site/index.html +346 -0
  55. package/site/styles.css +159 -0
  56. package/skills/manage-project-quality/SKILL.md +18 -2
  57. package/skills/manage-project-quality/assets/documentation-report.md +3 -3
  58. package/skills/manage-project-quality/assets/engineering-report.md +3 -3
  59. package/skills/manage-project-quality/assets/security-report.md +3 -3
  60. package/skills/manage-project-quality/references/documentation-01-system-documentation.md +13 -0
  61. package/skills/manage-project-quality/references/documentation-02-project-governance.md +13 -0
  62. package/skills/manage-project-quality/references/documentation-03-development-records.md +13 -0
  63. package/skills/manage-project-quality/references/documentation-04-testing-evidence.md +13 -0
  64. package/skills/manage-project-quality/references/documentation-05-operations-runbooks.md +13 -0
  65. package/skills/manage-project-quality/references/documentation-06-future-proposals.md +13 -0
  66. package/skills/manage-project-quality/references/documentation-07-archive-governance.md +13 -0
  67. package/skills/manage-project-quality/references/documentation-full-reference.md +24 -0
  68. package/skills/manage-project-quality/references/documentation-governance.md +2 -2
  69. package/skills/manage-project-quality/references/engineering-01-query-performance.md +17 -27
  70. package/skills/manage-project-quality/references/engineering-02-networking-fundamentals.md +17 -27
  71. package/skills/manage-project-quality/references/engineering-03-rate-limiting-algorithms.md +18 -28
  72. package/skills/manage-project-quality/references/engineering-04-production-debugging.md +17 -27
  73. package/skills/manage-project-quality/references/engineering-05-code-review-practices.md +17 -27
  74. package/skills/manage-project-quality/references/engineering-06-data-modeling.md +17 -27
  75. package/skills/manage-project-quality/references/engineering-07-cloud-cost-saving.md +17 -27
  76. package/skills/manage-project-quality/references/engineering-08-testing-types.md +17 -27
  77. package/skills/manage-project-quality/references/engineering-09-message-queues.md +17 -27
  78. package/skills/manage-project-quality/references/engineering-10-api-design-compatibility.md +14 -0
  79. package/skills/manage-project-quality/references/engineering-11-reliability-slos.md +14 -0
  80. package/skills/manage-project-quality/references/engineering-12-observability-telemetry.md +14 -0
  81. package/skills/manage-project-quality/references/engineering-13-deployment-change-safety.md +14 -0
  82. package/skills/manage-project-quality/references/engineering-14-capacity-concurrency.md +14 -0
  83. package/skills/manage-project-quality/references/engineering-full-reference.md +24 -144
  84. package/skills/manage-project-quality/references/engineering-protocol.md +1 -1
  85. package/skills/manage-project-quality/references/security-01-design-architecture.md +11 -19
  86. package/skills/manage-project-quality/references/security-02-local-development.md +13 -21
  87. package/skills/manage-project-quality/references/security-03-database-backend.md +18 -26
  88. package/skills/manage-project-quality/references/security-04-api-layer.md +23 -31
  89. package/skills/manage-project-quality/references/security-05-frontend-ui.md +16 -24
  90. package/skills/manage-project-quality/references/security-06-application-security-testing.md +22 -28
  91. package/skills/manage-project-quality/references/security-07-cicd-release-engineering.md +13 -21
  92. package/skills/manage-project-quality/references/security-08-cloud-infrastructure.md +17 -25
  93. package/skills/manage-project-quality/references/security-09-edge-cdn-dns.md +16 -24
  94. package/skills/manage-project-quality/references/security-10-release-rollout.md +13 -21
  95. package/skills/manage-project-quality/references/security-11-post-release-monitoring-ir.md +15 -23
  96. package/skills/manage-project-quality/references/security-12-ongoing-operations.md +24 -32
  97. package/skills/manage-project-quality/references/security-full-reference.md +30 -3163
  98. package/skills/manage-project-quality/scripts/check-report.mjs +67 -16
  99. package/src/api/index.mjs +4 -0
  100. package/src/cli/arguments.mjs +27 -3
  101. package/src/cli/help.mjs +53 -18
  102. package/src/cli/main.mjs +66 -9
  103. package/src/commands/audit.mjs +146 -31
  104. package/src/commands/doctor.mjs +1 -1
  105. package/src/commands/guide.mjs +12 -0
  106. package/src/commands/list.mjs +1 -1
  107. package/src/commands/setup.mjs +9 -4
  108. package/src/commands/skill.mjs +1 -0
  109. package/src/commands/template.mjs +32 -0
  110. package/src/commands/validate.mjs +36 -4
  111. package/src/commands/website.mjs +26 -0
  112. package/src/core/config.mjs +61 -0
  113. package/src/core/files.mjs +47 -6
  114. package/templates/adr.md +20 -0
  115. package/templates/change-record.md +18 -0
  116. package/templates/incident-review.md +20 -0
  117. package/templates/runbook.md +18 -0
  118. package/templates/test-evidence.md +18 -0
  119. package/tests/cli.test.mjs +226 -0
  120. package/tests/content.test.mjs +18 -0
package/CHANGELOG.md ADDED
@@ -0,0 +1,32 @@
1
+ # Changelog
2
+
3
+ Notable user-visible changes are recorded here. Versions follow semantic versioning.
4
+
5
+ ## 5.0.0 - 2026-10-14
6
+
7
+ ### Added
8
+
9
+ - Configuration-aware documentation audits with text, Markdown, JSON, report, and strict modes.
10
+ - Separate security and engineering worksheet schemas.
11
+ - Five documentation templates and five new engineering review topics.
12
+ - Seven canonical documentation guidance areas with CLI discovery and progressive skill references.
13
+ - Package-installation smoke testing and monthly maintenance automation.
14
+
15
+ ### Changed
16
+
17
+ - Node.js 22 is now the minimum supported runtime.
18
+ - Catalog schema is version 2 and records review dates.
19
+ - Security guidance uses current OWASP and NIST baselines and safer authorization boundaries.
20
+ - Canonical commands are `security worksheet` and `engineering worksheet`; v4 aliases remain supported.
21
+
22
+ ### Fixed
23
+
24
+ - Invalid options and installation targets are rejected.
25
+ - Local report dates no longer use the previous UTC calendar day.
26
+ - Repeated reports avoid accidental filename collisions.
27
+ - Repeated templates support descriptive names and collision-safe filenames.
28
+ - Generated worksheets pass the bundled schema-aware report validator.
29
+ - Documentation audits validate required metadata fields, dates, same-document anchors, and exact persisted formats.
30
+ - Forced skill updates replace the owned skill cleanly instead of retaining obsolete files.
31
+ - Stale package metadata, legacy folder instructions, content paths, duplicate headings, and report validation gaps were removed.
32
+ - Version-tag publishing verifies release identity and creates the matching GitHub Release.
package/README.md CHANGED
@@ -1,82 +1,88 @@
1
1
  # Agent Docs & Quality Kit
2
2
 
3
- Documentation governance, evidence-based security audits, and engineering-quality reviews in one installable CLI and one progressive Codex skill.
3
+ Documentation governance, evidence-based security assurance, and engineering-quality reviews in one installable CLI and one progressive Codex skill.
4
4
 
5
5
  [![CI](https://github.com/ghostbyte1014/Agent_Docs_Kit/actions/workflows/ci.yml/badge.svg)](https://github.com/ghostbyte1014/Agent_Docs_Kit/actions/workflows/ci.yml)
6
6
  [![npm](https://img.shields.io/npm/v/@ghostbyte/agent-docs-kit.svg)](https://www.npmjs.com/package/@ghostbyte/agent-docs-kit)
7
7
  [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
8
8
 
9
- ## What each part is for
10
-
11
9
  | Workflow | Purpose | Result model |
12
10
  |---|---|---|
13
- | Documentation | Keep scope, architecture, decisions, operations, and change history navigable and current. | Current / Needs update / Reference / Archived |
14
- | Security | Test security controls with evidence and expose release risk. | Pass / Fail / Unverified / N/A |
15
- | Engineering | Review maintainability, reliability, performance, testing, operability, and cost tradeoffs. | Applied / Partial / Recommended / Unverified / N/A |
11
+ | Documentation | Keep scope, architecture, decisions, operations, and history navigable and current. | Check results plus configurable templates and reports |
12
+ | Security | Review security controls against evidence and expose release risk. | Pass / Fail / Unverified / N/A |
13
+ | Engineering | Review reliability, maintainability, performance, testing, operability, and cost. | Applied / Partial / Recommended / Unverified / N/A |
14
+
15
+ Security can block a release. Engineering advice is normally non-blocking. Documentation policy improves governance but is technically enforced only when CI or another control runs it.
16
16
 
17
- Security can block a release. Engineering advice is normally non-blocking. Documentation policy improves governance but becomes technically enforceable only when backed by hooks or CI.
17
+ ## Run without installing
18
18
 
19
- ## Try it without installing
19
+ Requires Node.js 22 or newer.
20
20
 
21
21
  ```bash
22
22
  npx @ghostbyte/agent-docs-kit@latest
23
+ npx @ghostbyte/agent-docs-kit@latest setup --dry-run
24
+ npx @ghostbyte/agent-docs-kit@latest list documentation
25
+ npx @ghostbyte/agent-docs-kit@latest documentation guide system-documentation
26
+ npx @ghostbyte/agent-docs-kit@latest audit documentation --strict
27
+ npx @ghostbyte/agent-docs-kit@latest list security
28
+ npx @ghostbyte/agent-docs-kit@latest security worksheet api-layer
29
+ npx @ghostbyte/agent-docs-kit@latest list engineering
30
+ npx @ghostbyte/agent-docs-kit@latest engineering worksheet reliability-slos
31
+ npx @ghostbyte/agent-docs-kit@latest template create adr --name cache-policy
23
32
  ```
24
33
 
25
- The no-argument command opens a guided menu in an interactive terminal. Direct commands work well in scripts:
34
+ The no-argument command opens a guided menu in an interactive terminal. Installation performs no setup and changes no project files.
35
+
36
+ The canonical library contains seven documentation areas, 12 security phases, and 14 engineering topics under `content/`. The generated skill loads only the selected reference instead of placing all 33 areas in context.
37
+
38
+ ## Install the command
39
+
40
+ Project-local installation:
26
41
 
27
42
  ```bash
28
- npx @ghostbyte/agent-docs-kit@latest setup --dry-run
29
- npx @ghostbyte/agent-docs-kit@latest setup
30
- npx @ghostbyte/agent-docs-kit@latest audit documentation
31
- npx @ghostbyte/agent-docs-kit@latest list security
32
- npx @ghostbyte/agent-docs-kit@latest audit security api-layer --style learning
33
- npx @ghostbyte/agent-docs-kit@latest review engineering testing-types
34
- npx @ghostbyte/agent-docs-kit@latest skill install --target project
43
+ npm install --save-dev @ghostbyte/agent-docs-kit@latest
44
+ npx agent-docs --version
45
+ npx agent-docs setup --dry-run
35
46
  ```
36
47
 
37
- Installing the package performs no setup and changes no project files. Mutation happens only after an explicit command:
48
+ Global installation:
38
49
 
39
50
  ```bash
40
- npm install --save-dev @ghostbyte/agent-docs-kit
41
- npx agent-docs setup
51
+ npm install --global @ghostbyte/agent-docs-kit@latest
52
+ agent-docs --version
53
+ agent-docs setup --dry-run
42
54
  ```
43
55
 
44
- Existing files are skipped unless `--force` is supplied. Use `--dry-run` to preview owned writes.
45
-
46
- ## Codex skill
56
+ Setup files are skipped unless `--force` is explicit. Reports and templates preserve earlier records by selecting a numbered filename; use `--name <slug>` to name a template explicitly. Configure paths and required documents in `.agent-docs/config.json` after setup.
47
57
 
48
- The package contains `manage-project-quality`, a single router skill whose references are loaded by selected workflow and phase. Install it into the current project with:
58
+ ## Install the Codex skill
49
59
 
50
60
  ```bash
51
- npx agent-docs skill install --target project
61
+ npx @ghostbyte/agent-docs-kit@latest skill install --target project
52
62
  ```
53
63
 
54
- This creates `.agents/skills/manage-project-quality`. For a user-level Codex installation, explicitly run `npx agent-docs skill install --target codex`.
55
-
56
- ## Maintainer setup
57
-
58
- See [GitHub and npm setup](docs/GITHUB_AND_NPM_SETUP.md) for the commands to create/push the repository, enable GitHub Pages, verify the npm package name, publish the first version, and configure trusted publishing. The package name and repository URL are configured for `ghostbyte1014`; change them before release if the actual owner or repository differs.
64
+ This creates `.agents/skills/manage-project-quality`. Use `--target codex` only when you intentionally want a user-level skill available to future projects.
59
65
 
60
- Further documentation:
66
+ ## Documentation
61
67
 
62
68
  - [Purpose and boundaries](docs/PURPOSE.md)
63
- - [Architecture and complete file structure](docs/ARCHITECTURE.md)
69
+ - [Architecture and file structure](docs/ARCHITECTURE.md)
70
+ - [Content maintenance](docs/CONTENT_MAINTENANCE.md)
71
+ - [Security policy](SECURITY.md)
64
72
  - [Security model](docs/SECURITY_MODEL.md)
65
73
  - [Release process](docs/RELEASE_PROCESS.md)
66
- - [Legacy v3.2 compiled kit](docs/archive/AGENT_DOCS_KIT_v3.2.md)
74
+ - [GitHub and npm setup](docs/GITHUB_AND_NPM_SETUP.md)
75
+ - [Changelog](CHANGELOG.md)
67
76
 
68
77
  ## Development
69
78
 
70
79
  ```bash
71
80
  npm install
72
- npm test
73
- npm run validate
74
- npm run build
81
+ npm run release:check
75
82
  npm run site:preview
76
- npm pack --dry-run
77
83
  ```
78
84
 
79
- There are no runtime dependencies and no lifecycle install script.
85
+ There are no runtime dependencies and no install lifecycle script.
80
86
 
81
87
  ## License
82
88
 
package/SECURITY.md ADDED
@@ -0,0 +1,11 @@
1
+ # Security policy
2
+
3
+ ## Supported versions
4
+
5
+ Security fixes are provided for the current npm release. Upgrade with `npm install --global @ghostbyte/agent-docs-kit@latest` or use the version-pinned `npx` form.
6
+
7
+ ## Reporting a vulnerability
8
+
9
+ Do not open a public issue for an exploitable vulnerability or include secrets, personal data, or live-target details in a report. Use GitHub private vulnerability reporting for `ghostbyte1014/Agent_Docs_Kit`. Include the affected version, impact, reproduction conditions, and a safe proof of concept.
10
+
11
+ The project’s worksheets are review aids. They do not automatically scan targets, prove compliance, or replace professional security testing.
@@ -1,5 +1,72 @@
1
1
  {
2
- "schemaVersion": 1,
2
+ "schemaVersion": 2,
3
+ "lastReviewed": "2026-10-14",
4
+ "reviewDue": "2027-01-14",
5
+ "documentation": [
6
+ {
7
+ "id": "01",
8
+ "slug": "system-documentation",
9
+ "title": "System Documentation",
10
+ "aliases": ["1", "system"],
11
+ "source": "content/documentation/01-system-documentation.md",
12
+ "lastReviewed": "2026-10-14",
13
+ "reviewDue": "2027-01-14"
14
+ },
15
+ {
16
+ "id": "02",
17
+ "slug": "project-governance",
18
+ "title": "Project Governance",
19
+ "aliases": ["2", "project"],
20
+ "source": "content/documentation/02-project-governance.md",
21
+ "lastReviewed": "2026-10-14",
22
+ "reviewDue": "2027-01-14"
23
+ },
24
+ {
25
+ "id": "03",
26
+ "slug": "development-records",
27
+ "title": "Development Records",
28
+ "aliases": ["3", "development"],
29
+ "source": "content/documentation/03-development-records.md",
30
+ "lastReviewed": "2026-10-14",
31
+ "reviewDue": "2027-01-14"
32
+ },
33
+ {
34
+ "id": "04",
35
+ "slug": "testing-evidence",
36
+ "title": "Testing & Evidence",
37
+ "aliases": ["4", "testing"],
38
+ "source": "content/documentation/04-testing-evidence.md",
39
+ "lastReviewed": "2026-10-14",
40
+ "reviewDue": "2027-01-14"
41
+ },
42
+ {
43
+ "id": "05",
44
+ "slug": "operations-runbooks",
45
+ "title": "Operations & Runbooks",
46
+ "aliases": ["5", "operations"],
47
+ "source": "content/documentation/05-operations-runbooks.md",
48
+ "lastReviewed": "2026-10-14",
49
+ "reviewDue": "2027-01-14"
50
+ },
51
+ {
52
+ "id": "06",
53
+ "slug": "future-proposals",
54
+ "title": "Future Proposals",
55
+ "aliases": ["6", "future"],
56
+ "source": "content/documentation/06-future-proposals.md",
57
+ "lastReviewed": "2026-10-14",
58
+ "reviewDue": "2027-01-14"
59
+ },
60
+ {
61
+ "id": "07",
62
+ "slug": "archive-governance",
63
+ "title": "Archive Governance",
64
+ "aliases": ["7", "archive"],
65
+ "source": "content/documentation/07-archive-governance.md",
66
+ "lastReviewed": "2026-10-14",
67
+ "reviewDue": "2027-01-14"
68
+ }
69
+ ],
3
70
  "security": [
4
71
  {
5
72
  "id": "01",
@@ -8,7 +75,9 @@
8
75
  "aliases": [
9
76
  "1"
10
77
  ],
11
- "source": "content/security/01-design-architecture.md"
78
+ "source": "content/security/01-design-architecture.md",
79
+ "lastReviewed": "2026-10-14",
80
+ "reviewDue": "2027-01-14"
12
81
  },
13
82
  {
14
83
  "id": "02",
@@ -17,7 +86,9 @@
17
86
  "aliases": [
18
87
  "2"
19
88
  ],
20
- "source": "content/security/02-local-development.md"
89
+ "source": "content/security/02-local-development.md",
90
+ "lastReviewed": "2026-10-14",
91
+ "reviewDue": "2027-01-14"
21
92
  },
22
93
  {
23
94
  "id": "03",
@@ -26,7 +97,9 @@
26
97
  "aliases": [
27
98
  "3"
28
99
  ],
29
- "source": "content/security/03-database-backend.md"
100
+ "source": "content/security/03-database-backend.md",
101
+ "lastReviewed": "2026-10-14",
102
+ "reviewDue": "2027-01-14"
30
103
  },
31
104
  {
32
105
  "id": "04",
@@ -35,7 +108,9 @@
35
108
  "aliases": [
36
109
  "4"
37
110
  ],
38
- "source": "content/security/04-api-layer.md"
111
+ "source": "content/security/04-api-layer.md",
112
+ "lastReviewed": "2026-10-14",
113
+ "reviewDue": "2027-01-14"
39
114
  },
40
115
  {
41
116
  "id": "05",
@@ -44,7 +119,9 @@
44
119
  "aliases": [
45
120
  "5"
46
121
  ],
47
- "source": "content/security/05-frontend-ui.md"
122
+ "source": "content/security/05-frontend-ui.md",
123
+ "lastReviewed": "2026-10-14",
124
+ "reviewDue": "2027-01-14"
48
125
  },
49
126
  {
50
127
  "id": "06",
@@ -53,7 +130,9 @@
53
130
  "aliases": [
54
131
  "6"
55
132
  ],
56
- "source": "content/security/06-application-security-testing.md"
133
+ "source": "content/security/06-application-security-testing.md",
134
+ "lastReviewed": "2026-10-14",
135
+ "reviewDue": "2027-01-14"
57
136
  },
58
137
  {
59
138
  "id": "07",
@@ -62,7 +141,9 @@
62
141
  "aliases": [
63
142
  "7"
64
143
  ],
65
- "source": "content/security/07-cicd-release-engineering.md"
144
+ "source": "content/security/07-cicd-release-engineering.md",
145
+ "lastReviewed": "2026-10-14",
146
+ "reviewDue": "2027-01-14"
66
147
  },
67
148
  {
68
149
  "id": "08",
@@ -71,7 +152,9 @@
71
152
  "aliases": [
72
153
  "8"
73
154
  ],
74
- "source": "content/security/08-cloud-infrastructure.md"
155
+ "source": "content/security/08-cloud-infrastructure.md",
156
+ "lastReviewed": "2026-10-14",
157
+ "reviewDue": "2027-01-14"
75
158
  },
76
159
  {
77
160
  "id": "09",
@@ -80,7 +163,9 @@
80
163
  "aliases": [
81
164
  "9"
82
165
  ],
83
- "source": "content/security/09-edge-cdn-dns.md"
166
+ "source": "content/security/09-edge-cdn-dns.md",
167
+ "lastReviewed": "2026-10-14",
168
+ "reviewDue": "2027-01-14"
84
169
  },
85
170
  {
86
171
  "id": "10",
@@ -89,7 +174,9 @@
89
174
  "aliases": [
90
175
  "10"
91
176
  ],
92
- "source": "content/security/10-release-rollout.md"
177
+ "source": "content/security/10-release-rollout.md",
178
+ "lastReviewed": "2026-10-14",
179
+ "reviewDue": "2027-01-14"
93
180
  },
94
181
  {
95
182
  "id": "11",
@@ -98,7 +185,9 @@
98
185
  "aliases": [
99
186
  "11"
100
187
  ],
101
- "source": "content/security/11-post-release-monitoring-ir.md"
188
+ "source": "content/security/11-post-release-monitoring-ir.md",
189
+ "lastReviewed": "2026-10-14",
190
+ "reviewDue": "2027-01-14"
102
191
  },
103
192
  {
104
193
  "id": "12",
@@ -107,7 +196,9 @@
107
196
  "aliases": [
108
197
  "12"
109
198
  ],
110
- "source": "content/security/12-ongoing-operations.md"
199
+ "source": "content/security/12-ongoing-operations.md",
200
+ "lastReviewed": "2026-10-14",
201
+ "reviewDue": "2027-01-14"
111
202
  }
112
203
  ],
113
204
  "engineering": [
@@ -118,7 +209,9 @@
118
209
  "aliases": [
119
210
  "1"
120
211
  ],
121
- "source": "content/engineering/01-query-performance.md"
212
+ "source": "content/engineering/01-query-performance.md",
213
+ "lastReviewed": "2026-10-14",
214
+ "reviewDue": "2027-04-14"
122
215
  },
123
216
  {
124
217
  "id": "02",
@@ -127,7 +220,9 @@
127
220
  "aliases": [
128
221
  "2"
129
222
  ],
130
- "source": "content/engineering/02-networking-fundamentals.md"
223
+ "source": "content/engineering/02-networking-fundamentals.md",
224
+ "lastReviewed": "2026-10-14",
225
+ "reviewDue": "2027-04-14"
131
226
  },
132
227
  {
133
228
  "id": "03",
@@ -136,7 +231,9 @@
136
231
  "aliases": [
137
232
  "3"
138
233
  ],
139
- "source": "content/engineering/03-rate-limiting-algorithms.md"
234
+ "source": "content/engineering/03-rate-limiting-algorithms.md",
235
+ "lastReviewed": "2026-10-14",
236
+ "reviewDue": "2027-04-14"
140
237
  },
141
238
  {
142
239
  "id": "04",
@@ -145,7 +242,9 @@
145
242
  "aliases": [
146
243
  "4"
147
244
  ],
148
- "source": "content/engineering/04-production-debugging.md"
245
+ "source": "content/engineering/04-production-debugging.md",
246
+ "lastReviewed": "2026-10-14",
247
+ "reviewDue": "2027-04-14"
149
248
  },
150
249
  {
151
250
  "id": "05",
@@ -154,7 +253,9 @@
154
253
  "aliases": [
155
254
  "5"
156
255
  ],
157
- "source": "content/engineering/05-code-review-practices.md"
256
+ "source": "content/engineering/05-code-review-practices.md",
257
+ "lastReviewed": "2026-10-14",
258
+ "reviewDue": "2027-04-14"
158
259
  },
159
260
  {
160
261
  "id": "06",
@@ -163,7 +264,9 @@
163
264
  "aliases": [
164
265
  "6"
165
266
  ],
166
- "source": "content/engineering/06-data-modeling.md"
267
+ "source": "content/engineering/06-data-modeling.md",
268
+ "lastReviewed": "2026-10-14",
269
+ "reviewDue": "2027-04-14"
167
270
  },
168
271
  {
169
272
  "id": "07",
@@ -172,7 +275,9 @@
172
275
  "aliases": [
173
276
  "7"
174
277
  ],
175
- "source": "content/engineering/07-cloud-cost-saving.md"
278
+ "source": "content/engineering/07-cloud-cost-saving.md",
279
+ "lastReviewed": "2026-10-14",
280
+ "reviewDue": "2027-04-14"
176
281
  },
177
282
  {
178
283
  "id": "08",
@@ -181,7 +286,9 @@
181
286
  "aliases": [
182
287
  "8"
183
288
  ],
184
- "source": "content/engineering/08-testing-types.md"
289
+ "source": "content/engineering/08-testing-types.md",
290
+ "lastReviewed": "2026-10-14",
291
+ "reviewDue": "2027-04-14"
185
292
  },
186
293
  {
187
294
  "id": "09",
@@ -190,7 +297,69 @@
190
297
  "aliases": [
191
298
  "9"
192
299
  ],
193
- "source": "content/engineering/09-message-queues.md"
300
+ "source": "content/engineering/09-message-queues.md",
301
+ "lastReviewed": "2026-10-14",
302
+ "reviewDue": "2027-04-14"
303
+ },
304
+ {
305
+ "id": "10",
306
+ "slug": "api-design-compatibility",
307
+ "title": "API Design & Compatibility",
308
+ "aliases": [
309
+ "10",
310
+ "api-design"
311
+ ],
312
+ "source": "content/engineering/10-api-design-compatibility.md",
313
+ "lastReviewed": "2026-10-14",
314
+ "reviewDue": "2027-04-14"
315
+ },
316
+ {
317
+ "id": "11",
318
+ "slug": "reliability-slos",
319
+ "title": "Reliability, SLOs & Error Budgets",
320
+ "aliases": [
321
+ "11",
322
+ "reliability"
323
+ ],
324
+ "source": "content/engineering/11-reliability-slos.md",
325
+ "lastReviewed": "2026-10-14",
326
+ "reviewDue": "2027-04-14"
327
+ },
328
+ {
329
+ "id": "12",
330
+ "slug": "observability-telemetry",
331
+ "title": "Observability & Telemetry",
332
+ "aliases": [
333
+ "12",
334
+ "observability"
335
+ ],
336
+ "source": "content/engineering/12-observability-telemetry.md",
337
+ "lastReviewed": "2026-10-14",
338
+ "reviewDue": "2027-04-14"
339
+ },
340
+ {
341
+ "id": "13",
342
+ "slug": "deployment-change-safety",
343
+ "title": "Deployment & Change Safety",
344
+ "aliases": [
345
+ "13",
346
+ "deployment"
347
+ ],
348
+ "source": "content/engineering/13-deployment-change-safety.md",
349
+ "lastReviewed": "2026-10-14",
350
+ "reviewDue": "2027-04-14"
351
+ },
352
+ {
353
+ "id": "14",
354
+ "slug": "capacity-concurrency",
355
+ "title": "Capacity, Concurrency & Resource Management",
356
+ "aliases": [
357
+ "14",
358
+ "capacity"
359
+ ],
360
+ "source": "content/engineering/14-capacity-concurrency.md",
361
+ "lastReviewed": "2026-10-14",
362
+ "reviewDue": "2027-04-14"
194
363
  }
195
364
  ]
196
365
  }
@@ -0,0 +1,13 @@
1
+ # System Documentation
2
+
3
+ Use this area to explain what the system is, where its boundaries are, and how its important parts relate. Prefer durable facts over implementation narration.
4
+
5
+ | Documentation ID | Record | Purpose | Evidence question |
6
+ |---|---|---|---|
7
+ | DOC-01-01 | System overview | Gives new contributors a reliable starting point. | Can a reader identify users, responsibilities, dependencies, and boundaries? |
8
+ | DOC-01-02 | Architecture map | Shows major components and information flow. | Does the map match the deployed system and link to authoritative details? |
9
+ | DOC-01-03 | Data ownership | Prevents ambiguous sources of truth. | Is each important data domain tied to an owner and authoritative store? |
10
+ | DOC-01-04 | External dependencies | Makes operational and security assumptions visible. | Are critical third-party and platform dependencies named with their role? |
11
+ | DOC-01-05 | Trust boundaries | Connects design documentation to security review. | Are identity, network, tenant, and data trust boundaries explicit? |
12
+ | DOC-01-06 | Constraints | Preserves the reasons behind non-obvious architecture. | Are regulatory, performance, compatibility, and organizational constraints recorded? |
13
+ | DOC-01-07 | Ownership | Gives readers a route to clarification. | Does every major subsystem have an accountable owner or team? |
@@ -0,0 +1,13 @@
1
+ # Project Governance
2
+
3
+ Use this area to keep current scope, decisions, delivery status, and ownership separate from proposals and historical records.
4
+
5
+ | Documentation ID | Record | Purpose | Evidence question |
6
+ |---|---|---|---|
7
+ | DOC-02-01 | Current scope | Prevents future ideas from being mistaken for commitments. | Are included outcomes, exclusions, and success criteria explicit? |
8
+ | DOC-02-02 | Requirements | Connects implementation to accepted needs. | Can each active requirement be traced to an owner and validation method? |
9
+ | DOC-02-03 | Decision records | Preserves context that code cannot explain. | Do material decisions record context, choice, alternatives, and consequences? |
10
+ | DOC-02-04 | Delivery status | Gives readers one current project view. | Is the status dated, owned, and separated from historical updates? |
11
+ | DOC-02-05 | Risk register | Keeps known uncertainty visible. | Are significant delivery risks assigned an owner and response? |
12
+ | DOC-02-06 | Change history | Explains meaningful changes without duplicating Git history. | Are user-visible and operational changes summarized by release? |
13
+ | DOC-02-07 | Authority map | Prevents conflicting sources of truth. | Is the authoritative document identified for each major project concern? |
@@ -0,0 +1,13 @@
1
+ # Development Records
2
+
3
+ Use this area for implementation guidance and review records that help contributors change the system safely.
4
+
5
+ | Documentation ID | Record | Purpose | Evidence question |
6
+ |---|---|---|---|
7
+ | DOC-03-01 | Development setup | Makes a clean environment reproducible. | Can a contributor reach a verified local state from documented prerequisites? |
8
+ | DOC-03-02 | Repository map | Reduces rediscovery and misplaced changes. | Are important directories, generated files, and ownership boundaries explained? |
9
+ | DOC-03-03 | Coding conventions | Records project-specific rules rather than generic advice. | Are non-obvious conventions linked to automated enforcement where possible? |
10
+ | DOC-03-04 | Change records | Captures intent, validation, and rollback for significant work. | Does each important change explain scope, risk, tests, and deployment result? |
11
+ | DOC-03-05 | Engineering reviews | Retains evidence and recommendations over time. | Are reviews dated, scoped, owned, and linked to follow-up work? |
12
+ | DOC-03-06 | Generated-content policy | Prevents manual edits from being overwritten. | Are source files and regeneration commands clear for every generated artifact? |
13
+ | DOC-03-07 | Contribution workflow | Makes review expectations predictable. | Are branch, review, test, and merge requirements current and discoverable? |
@@ -0,0 +1,13 @@
1
+ # Testing and Evidence
2
+
3
+ Use this area to connect quality claims to reproducible test plans, results, limitations, and retained evidence.
4
+
5
+ | Documentation ID | Record | Purpose | Evidence question |
6
+ |---|---|---|---|
7
+ | DOC-04-01 | Test strategy | Explains which risks each test layer addresses. | Are unit, integration, contract, end-to-end, and manual responsibilities explicit? |
8
+ | DOC-04-02 | Test plans | Defines scope and expected outcomes before execution. | Does each material test pass name environment, inputs, procedure, and acceptance criteria? |
9
+ | DOC-04-03 | Evidence records | Makes results independently understandable. | Can a reviewer connect a claim to dated, reproducible evidence? |
10
+ | DOC-04-04 | Security reviews | Separates generated worksheets from verified findings. | Are authorization, target, status, evidence, owner, and verification recorded? |
11
+ | DOC-04-05 | Known limitations | Prevents incomplete coverage from appearing complete. | Are unavailable environments, skipped checks, and confidence limits explicit? |
12
+ | DOC-04-06 | Defect traceability | Connects failures to remediation and retesting. | Can every material failure be traced to an owner and verification result? |
13
+ | DOC-04-07 | Retention policy | Preserves useful evidence without retaining sensitive data indefinitely. | Are evidence location, access, redaction, and retention expectations defined? |
@@ -0,0 +1,13 @@
1
+ # Operations and Runbooks
2
+
3
+ Use this area for the procedures and context needed to deploy, observe, recover, and safely operate the system.
4
+
5
+ | Documentation ID | Record | Purpose | Evidence question |
6
+ |---|---|---|---|
7
+ | DOC-05-01 | Deployment procedure | Makes releases repeatable and reviewable. | Are prerequisites, promotion, verification, rollback, and ownership documented? |
8
+ | DOC-05-02 | Configuration guide | Prevents hidden environment assumptions. | Are required settings described without publishing secret values? |
9
+ | DOC-05-03 | Observability guide | Helps operators connect signals to user impact. | Are dashboards, alerts, logs, traces, and known gaps discoverable? |
10
+ | DOC-05-04 | Operational runbooks | Turns alerts and recurring tasks into safe procedures. | Does each runbook include access, steps, verification, rollback, and escalation? |
11
+ | DOC-05-05 | Incident response | Establishes roles and communication before failure. | Are severity, command, escalation, evidence preservation, and review practices clear? |
12
+ | DOC-05-06 | Recovery procedure | Converts backup claims into tested recovery capability. | Are recovery objectives, restore steps, dependencies, and test results current? |
13
+ | DOC-05-07 | Support ownership | Avoids dead ends during urgent work. | Are service ownership, on-call expectations, and escalation contacts maintained safely? |
@@ -0,0 +1,13 @@
1
+ # Future Proposals
2
+
3
+ Use this area for ideas that have not entered current scope. A proposal is not a commitment until it is accepted through the project’s decision process.
4
+
5
+ | Documentation ID | Record | Purpose | Evidence question |
6
+ |---|---|---|---|
7
+ | DOC-06-01 | Problem statement | Keeps proposals grounded in a real need. | Is the affected user, problem, and supporting evidence clear? |
8
+ | DOC-06-02 | Proposed outcome | Describes value without prematurely fixing implementation. | Is the desired outcome measurable and distinct from a chosen solution? |
9
+ | DOC-06-03 | Options | Preserves alternatives and tradeoffs. | Are credible alternatives, including doing nothing, compared fairly? |
10
+ | DOC-06-04 | Dependencies | Exposes prerequisites and external decisions. | Are technical, organizational, data, and vendor dependencies named? |
11
+ | DOC-06-05 | Risks and cost | Prevents benefits from hiding lifecycle costs. | Are delivery, operational, security, migration, and maintenance costs considered? |
12
+ | DOC-06-06 | Decision state | Stops unapproved work from appearing committed. | Is the proposal clearly marked proposed, accepted, rejected, deferred, or superseded? |
13
+ | DOC-06-07 | Promotion path | Defines how an accepted idea becomes current scope. | Does acceptance identify the decision record, owner, milestone, and documents to update? |
@@ -0,0 +1,13 @@
1
+ # Archive Governance
2
+
3
+ Use this area to retain useful history without allowing superseded material to compete with current documentation.
4
+
5
+ | Documentation ID | Record | Purpose | Evidence question |
6
+ |---|---|---|---|
7
+ | DOC-07-01 | Archive criteria | Makes retirement consistent. | Is material archived only when it is superseded, obsolete, or retained for traceability? |
8
+ | DOC-07-02 | Archive metadata | Explains why an old record remains. | Does each archived item identify archive date, reason, and responsible owner? |
9
+ | DOC-07-03 | Replacement links | Routes readers back to current authority. | Does superseded material link to its replacement when one exists? |
10
+ | DOC-07-04 | Search separation | Prevents stale guidance from dominating discovery. | Are archives clearly separated and labeled in navigation and search? |
11
+ | DOC-07-05 | Decision retention | Preserves context for consequential choices. | Are material decisions retained according to legal and project needs? |
12
+ | DOC-07-06 | Sensitive-data review | Prevents archives from becoming unmanaged exposure. | Are secrets, personal data, and unnecessary operational details removed or access-controlled? |
13
+ | DOC-07-07 | Periodic review | Avoids permanent accumulation without purpose. | Are retention obligations and deletion candidates reviewed on a defined cadence? |
@@ -0,0 +1,24 @@
1
+ # Documentation Governance Reference
2
+
3
+ This index routes documentation work to the smallest relevant area. The seven area files are canonical. Project-specific records are created from templates and checked against `.agent-docs/config.json`.
4
+
5
+ ## Governance contract
6
+
7
+ - Identify one authoritative source for each important concern.
8
+ - Record owner, status, last review date, and review due date when metadata is required.
9
+ - Separate current facts and commitments from proposals and archives.
10
+ - Link claims to repository or operational evidence instead of assuming completeness.
11
+ - Prefer concise navigation and focused documents over one unbounded handbook.
12
+ - Treat generated reports as evidence containers, not proof that checks passed.
13
+
14
+ ## Area index
15
+
16
+ 1. System documentation
17
+ 2. Project governance
18
+ 3. Development records
19
+ 4. Testing and evidence
20
+ 5. Operations and runbooks
21
+ 6. Future proposals
22
+ 7. Archive governance
23
+
24
+ Run `agent-docs list documentation` to discover selectors. Use `agent-docs audit documentation --strict` to check the configured project record.