arckit-cli 6.1.1__py3-none-any.whl
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.
- arckit_cli/__init__.py +1120 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/memory/sessions.md +293 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/_partials/RENDERING.md +22 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/_partials/document-control-uae.md +20 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/_partials/document-control-uk.md +16 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/adm-preliminary-template.md +135 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/adr-template.md +588 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/agent-design-template.md +390 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/agent-governance-template.md +90 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/agent-integration-template.md +159 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/agent-inventory-template.md +108 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/agent-maturity-template.md +388 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/agent-security-template.md +213 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/analysis-report-template.md +323 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/application-inventory-template.md +221 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/architecture-board-template.md +194 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/architecture-change-template.md +205 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/architecture-diagram-template.md +610 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/architecture-principles-template.md +632 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/architecture-repository-template.md +107 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/architecture-strategy-template.md +666 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/at-bvergg-template.md +252 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/at-dsgvo-template.md +354 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/at-nisg-template.md +236 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/au-aescsf-template.md +189 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/au-ai-assurance-template.md +243 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/au-disp-attestation-template.md +297 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/au-dss-template.md +302 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/au-e8-posture-template.md +377 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/au-energy-compliance-template.md +189 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/au-ism-controls-template.md +462 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/au-ndb-playbook-template.md +288 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/au-ot-security-template.md +204 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/au-pia-template.md +394 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/au-pspf-template.md +380 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/au-soci-cirmp-template.md +206 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/aws-research-template.md +605 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/azure-research-template.md +559 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/backlog-template.md +465 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/ca-aia-template.md +206 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/ca-atip-template.md +192 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/ca-charter-template.md +190 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/ca-cloud-residency-template.md +173 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/ca-fitaa-template.md +156 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/ca-gc-digital-standards-template.md +208 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/ca-itsg-33-template.md +228 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/ca-ocap-template.md +205 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/ca-ola-template.md +171 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/ca-pia-template.md +193 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/ca-pspc-template.md +214 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/ca-soia-template.md +219 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/capability-map-template.md +125 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/competitors-template.md +113 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/conformance-assessment-template.md +507 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/data-mesh-contract-template.md +851 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/data-model-template.md +1043 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/data-source-profile-template.md +80 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/datascout-template.md +546 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/devops-template.md +961 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/dfd-template.md +161 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/dld-review-template.md +427 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/dos-requirements-template.md +506 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/dpia-template.md +1200 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/eu-ai-act-template.md +227 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/eu-cra-template.md +176 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/eu-data-act-template.md +175 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/eu-dora-template.md +197 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/eu-dsa-template.md +183 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/eu-nis2-template.md +196 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/eu-rgpd-template.md +198 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/evaluation-criteria-template.md +719 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/finops-template.md +662 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/fr-algorithme-public-template.md +162 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/fr-anssi-carto-template.md +196 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/fr-anssi-template.md +190 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/fr-code-reuse-template.md +190 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/fr-dinum-template.md +195 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/fr-dr-template.md +187 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/fr-ebios-template.md +209 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/fr-irn-template.md +311 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/fr-marche-public-template.md +178 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/fr-pssi-template.md +270 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/fr-rgpd-template.md +195 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/fr-secnumcloud-template.md +188 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/framework-overview-template.md +247 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/gap-analysis-template.md +198 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/gcloud-clarify-template.md +340 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/gcloud-requirements-template.md +370 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/gcp-research-template.md +585 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/glossary-template.md +117 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/gov-code-search-template.md +213 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/gov-landscape-template.md +271 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/gov-reuse-template.md +214 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/grants-template.md +131 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/hld-review-template.md +760 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/jsp-936-template.md +1394 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/maturity-model-template.md +297 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/mlops-template.md +720 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/mod-secure-by-design-template.md +784 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/operationalize-template.md +1016 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/pages-template.html +5121 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/platform-design-template.md +1610 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/presentation-template.md +270 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/principles-compliance-assessment-template.md +389 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/project-plan-template.md +421 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/rationalization-template.md +208 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/requirements-template.md +1026 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/research-findings-template.md +939 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/risk-register-template.md +883 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/roadmap-template.md +787 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/service-assessment-prep-template.md +448 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/servicenow-design-template.md +273 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/sobc-template.md +1127 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/sow-template.md +785 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/stakeholder-drivers-template.md +493 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/story-template.md +889 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/tcop-review-template.md +593 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/tech-note-template.md +59 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/tenders-template.md +124 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/traceability-matrix-template.md +360 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/transition-architecture-template.md +286 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uae-ai-autonomy-tier-template.md +97 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uae-ai-charter-template.md +81 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uae-classification-template.md +86 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uae-cloud-residency-template.md +136 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uae-data-sharing-template.md +105 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uae-digital-records-template.md +97 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uae-ias-template.md +109 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uae-pdpl-template.md +105 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uae-priorities-alignment-template.md +99 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uae-procurement-template.md +115 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uae-uaepass-template.md +129 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uae-zero-bureaucracy-template.md +85 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uk-fs-consumer-duty-board-report-template.md +49 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uk-fs-consumer-duty-template.md +362 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uk-fs-ctp-dependency-register-template.md +24 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uk-fs-ctp-dependency-template.md +321 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uk-fs-safeguarding-reconciliation-template.md +77 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uk-fs-safeguarding-template.md +348 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uk-fs-sca-rts-exemption-matrix-template.md +47 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uk-fs-sca-rts-template.md +273 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uk-gov-ai-playbook-template.md +942 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uk-gov-atrs-template.md +1087 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uk-mdr-classification-template.md +307 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uk-nhs-dcb0129-case-template.md +214 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uk-nhs-dcb0129-hazard-template.md +217 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uk-nhs-dcb0129-safety-template.md +78 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uk-nhs-dcb0129-template.md +13 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uk-nhs-dcb0160-deployment-case-template.md +207 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uk-nhs-dcb0160-deployment-hazard-template.md +290 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uk-nhs-dcb0160-deployment-safety-template.md +81 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uk-nhs-dcb0160-template.md +13 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/uk-nhs-dtac-template.md +341 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/ukgov-secure-by-design-template.md +1031 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/us-ai-impact-template.md +212 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/us-ai-rmf-template.md +232 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/us-fedramp-readiness-template.md +209 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/us-fedramp-ssp-template.md +352 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/us-fisma-categorization-template.md +145 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/us-icam-template.md +216 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/us-nist-800-53-template.md +222 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/us-privacy-pia-template.md +191 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/us-sbom-eo-14028-template.md +253 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/us-zero-trust-template.md +234 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/vendor-profile-template.md +88 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/vendor-scoring-template.md +332 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/wardley-climate-template.md +269 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/wardley-doctrine-template.md +299 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/wardley-gameplay-template.md +346 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/wardley-map-template.md +587 -0
- arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/wardley-value-chain-template.md +256 -0
- arckit_cli-6.1.1.data/data/share/arckit/CHANGELOG.md +3554 -0
- arckit_cli-6.1.1.data/data/share/arckit/VERSION +1 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/DEPENDENCY-MATRIX.md +929 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/README.md +322 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/WORKFLOW-DIAGRAMS.md +1088 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/adm-preliminary.md +72 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/adr.md +60 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/agent-design.md +71 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/agent-governance.md +61 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/agent-integration.md +59 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/agent-inventory.md +60 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/agent-maturity.md +84 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/agent-security.md +63 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/ai-playbook.md +103 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/analyze.md +57 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/application-inventory.md +71 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/application-rationalization.md +71 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/architecture-board.md +60 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/architecture-change.md +73 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/architecture-repository.md +62 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/artifact-health.md +228 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/at-bvergg.md +86 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/at-dsgvo.md +75 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/at-nisg.md +94 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/atrs.md +98 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/au-aescsf.md +45 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/au-ai-assurance.md +84 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/au-disp-attestation.md +90 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/au-dss.md +76 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/au-e8-posture.md +73 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/au-energy-compliance.md +47 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/au-federal-overlay.md +199 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/au-ism-controls.md +78 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/au-ndb-playbook.md +80 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/au-ot-security.md +39 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/au-pia.md +72 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/au-pspf.md +81 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/au-soci-cirmp.md +40 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/autoresearch.md +334 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/aws-research.md +160 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/azure-research.md +157 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/backlog.md +58 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/build.md +132 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/business-capability-map.md +68 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/business-case.md +68 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/c4-layout-science.md +280 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/ca-aia.md +81 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/ca-atip.md +79 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/ca-charter.md +81 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/ca-cloud-residency.md +91 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/ca-fitaa.md +81 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/ca-gc-digital-standards.md +93 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/ca-itsg-33.md +80 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/ca-ocap.md +91 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/ca-ola.md +80 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/ca-pia.md +83 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/ca-pspc.md +96 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/ca-soia.md +87 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/codes-of-practice.md +154 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/competitors.md +202 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/conformance.md +153 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/create.md +61 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/custom-commands.md +236 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/customize.md +108 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/data-mesh-contract.md +239 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/data-model.md +69 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/data-quality-framework.md +118 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/datascout.md +162 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/declaration.md +59 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/design-review.md +66 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/devops.md +96 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/dfd.md +187 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/diagram.md +118 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/dld-review.md +102 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/dos.md +109 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/dpia.md +80 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/enterprise-scale.md +260 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/eu-ai-act.md +82 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/eu-cra.md +90 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/eu-data-act.md +85 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/eu-dora.md +83 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/eu-dsa.md +85 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/eu-nis2.md +82 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/eu-rgpd.md +76 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/evaluate.md +115 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/export-okf.md +70 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/finops.md +117 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/fr-algorithme-public.md +86 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/fr-anssi-carto.md +69 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/fr-anssi.md +79 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/fr-code-reuse.md +86 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/fr-dinum.md +83 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/fr-dr.md +88 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/fr-ebios.md +84 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/fr-irn.md +103 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/fr-marche-public.md +94 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/fr-pssi.md +87 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/fr-rgpd.md +75 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/fr-secnumcloud.md +80 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/framework.md +234 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/gap-analysis.md +70 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/gcloud-clarify.md +108 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/gcloud-competitors.md +61 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/gcloud-search.md +106 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/gcp-research.md +169 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/glossary.md +190 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/gov-code-search.md +119 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/gov-landscape.md +114 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/gov-reuse.md +112 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/govs-007-security.md +93 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/grants.md +106 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/graph-report.md +77 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/health.md +234 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/hld-review.md +110 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/hooks.md +121 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/impact.md +68 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/import-okf.md +67 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/init.md +159 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/jsp-936.md +60 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/knowledge-compounding.md +140 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/maturity-model.md +186 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/mcp-servers.md +329 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/migration.md +333 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/mlops.md +126 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/mod-secure.md +124 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/national-data-strategy.md +115 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/navigator.md +86 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/operationalize.md +143 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/pages.md +227 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/pinecone-mcp.md +128 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/plan.md +66 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/platform-design.md +600 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/presentation.md +137 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/pricing.md +62 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/principles-compliance.md +63 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/principles.md +55 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/procurement.md +57 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/productivity.md +217 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/remote-control.md +151 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/requirements.md +61 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/research.md +65 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/review.md +61 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/risk-management.md +70 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/risk.md +132 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/roadmap.md +58 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/roles/README.md +68 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/roles/business-analyst.md +70 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/roles/business-architect.md +70 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/roles/cdo.md +59 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/roles/ciso.md +61 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/roles/cto-cdio.md +59 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/roles/data-architect.md +68 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/roles/data-governance-manager.md +59 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/roles/delivery-manager.md +63 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/roles/devops-engineer.md +55 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/roles/enterprise-architect.md +84 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/roles/it-service-manager.md +55 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/roles/network-architect.md +58 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/roles/performance-analyst.md +67 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/roles/product-manager.md +62 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/roles/security-architect.md +78 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/roles/service-owner.md +58 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/roles/solution-architect.md +75 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/roles/technical-architect.md +68 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/score.md +91 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/sdd-lot1.md +61 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/sdd-lot2.md +62 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/sdd-lot3.md +62 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/search.md +71 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/secure.md +181 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/security-hooks.md +200 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/security.md +62 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/service-assessment.md +47 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/service-design.md +71 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/servicenow.md +152 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/session-memory.md +100 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/sobc.md +129 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/sow.md +125 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/stakeholder-analysis.md +51 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/stakeholders.md +138 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/start.md +276 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/story.md +61 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/strategy.md +211 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/submission-pack.md +72 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/supplier-profile.md +70 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/tcop.md +124 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/template-builder.md +125 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/tenders.md +193 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/testing-plugin-branches.md +79 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/traceability.md +58 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/transition-architecture.md +69 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/trello.md +139 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uae-ai-autonomy-tier.md +84 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uae-ai-charter.md +89 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uae-classification.md +73 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uae-cloud-residency.md +84 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uae-data-sharing.md +84 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uae-digital-records.md +71 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uae-ias.md +93 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uae-overlay-maintenance.md +154 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uae-overlay.md +208 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uae-pdpl.md +73 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uae-priorities-alignment.md +82 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uae-procurement.md +71 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uae-uaepass.md +83 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uae-zero-bureaucracy.md +80 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uk-fs-consumer-duty.md +178 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uk-fs-ctp-dependency.md +181 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uk-fs-payments-overlay.md +216 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uk-fs-safeguarding.md +176 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uk-fs-sca-rts.md +164 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uk-government/ai-playbook.md +56 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uk-government/algorithmic-transparency.md +44 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uk-government/digital-marketplace.md +55 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uk-government/secure-by-design.md +51 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uk-government/standards-map.md +108 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uk-government/technology-code-of-practice.md +63 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uk-mdr-classification.md +59 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uk-mod/secure-by-design.md +54 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uk-nhs-clinical-safety-overlay.md +214 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uk-nhs-dcb0129.md +64 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uk-nhs-dcb0160.md +62 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/uk-nhs-dtac.md +55 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/upgrading.md +130 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/us-ai-impact.md +71 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/us-ai-rmf.md +70 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/us-federal-overlay.md +111 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/us-fedramp-readiness.md +69 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/us-fedramp-ssp.md +71 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/us-fisma-categorization.md +68 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/us-icam.md +70 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/us-nist-800-53.md +70 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/us-privacy-pia.md +74 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/us-sbom-eo-14028.md +71 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/us-zero-trust.md +68 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/wardley-climate.md +122 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/wardley-doctrine.md +120 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/wardley-gameplay.md +123 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/wardley-value-chain.md +130 -0
- arckit_cli-6.1.1.data/data/share/arckit/docs/guides/wardley.md +173 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-codex/.agents/plugins/marketplace.json +20 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-codex/README.md +325 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-codex/VERSION +1 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-codex/docs/DEPENDENCY-MATRIX.md +616 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-codex/hooks/arckit-codex-hook.mjs +1270 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-codex/hooks/graph-inject.mjs +1497 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-codex/hooks/graph-rollups.mjs +247 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-codex/hooks/graph-utils.mjs +363 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-codex/hooks/hook-utils.mjs +383 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-codex/hooks/hooks.json +80 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-codex/hooks/okf-frontmatter.mjs +279 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-codex/hooks/project-context-builder.mjs +168 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-codex/hooks/sync-guides.mjs +1120 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-copilot/README.md +68 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-copilot/VERSION +1 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-copilot/docs/DEPENDENCY-MATRIX.md +616 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-opencode/LICENSE +21 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-opencode/README.md +65 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-opencode/VERSION +1 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-opencode/docs/DEPENDENCY-MATRIX.md +616 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-opencode/opencode.json +25 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-vibe/.mcp.json +63 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-vibe/LICENSE +26 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-vibe/README.md +407 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-vibe/VERSION +1 -0
- arckit_cli-6.1.1.data/data/share/arckit/extensions/arckit-vibe/vibe-config.toml +62 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/README.md +680 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/autoresearch/fixtures/000-global/ARC-000-PRIN-v1.0.md +120 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/autoresearch/fixtures/001-test-project/ARC-001-STKE-v1.0.md +100 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/autoresearch/fixtures/001-test-project/README.md +15 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/autoresearch/program-selfharness.md +748 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/autoresearch/program.md +269 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/bash/check-prerequisites.sh +250 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/bash/common.sh +359 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/bash/create-project.sh +408 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/bash/generate-document-id.sh +146 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/bash/list-projects.sh +359 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/bash/migrate-filenames.sh +553 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/bump-version.sh +293 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/check_doctype_collisions.py +30 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/check_recipes.py +94 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/check_references.py +144 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/convert_vibe_agents.py +198 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/convert_vibe_skills.py +499 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/converter.py +2002 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/create-sdg-repo.py +820 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/generate-arckit-architecture-hero.py +317 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/generate-arckit-hero.py +278 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/generate-release-notes.sh +112 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/managed-agents/README.md +105 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/managed-agents/arckit-agent.py +418 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/push-extensions.sh +424 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/python/apply_doc_control_marker.py +50 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/python/common.py +288 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/python/create-project.py +373 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/python/generate-document-id.py +96 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/python/list-projects.py +238 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/python/migrate_classification.py +94 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/render-brand-pngs.py +72 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/standardise-colon.py +128 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/sync-claude-plugin-layout.py +159 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/sync-shared-assets.py +132 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/tag-plugins.sh +65 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/tests/test-doc-types-dual-registration.mjs +57 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/tests/test-fde-templates.mjs +100 -0
- arckit_cli-6.1.1.data/data/share/arckit/scripts/tests/test-regime-registration.mjs +65 -0
- arckit_cli-6.1.1.dist-info/METADATA +1966 -0
- arckit_cli-6.1.1.dist-info/RECORD +482 -0
- arckit_cli-6.1.1.dist-info/WHEEL +4 -0
- arckit_cli-6.1.1.dist-info/entry_points.txt +2 -0
- arckit_cli-6.1.1.dist-info/licenses/LICENSE +26 -0
|
@@ -0,0 +1,1026 @@
|
|
|
1
|
+
# Project Requirements: [PROJECT_NAME]
|
|
2
|
+
|
|
3
|
+
> **Template Origin**: Official | **ArcKit Version**: [VERSION] | **Command**: `/arckit:requirements`
|
|
4
|
+
|
|
5
|
+
## Document Control
|
|
6
|
+
|
|
7
|
+
<!-- DOC-CONTROL-HEADER -->
|
|
8
|
+
<!-- Resolved at command-execution time to _partials/document-control-uk.md or _partials/document-control-uae.md based on plugin userConfig classification_scheme + governance_framework. See _partials/RENDERING.md (when present). -->
|
|
9
|
+
|
|
10
|
+
## Revision History
|
|
11
|
+
|
|
12
|
+
| Version | Date | Author | Changes | Approved By | Approval Date |
|
|
13
|
+
|---------|------|--------|---------|-------------|---------------|
|
|
14
|
+
| [VERSION] | [DATE] | ArcKit AI | Initial creation from `/arckit.[COMMAND]` command | [PENDING] | [PENDING] |
|
|
15
|
+
|
|
16
|
+
## Document Purpose
|
|
17
|
+
|
|
18
|
+
[Brief description of what this document is for and how it will be used]
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## Executive Summary
|
|
23
|
+
|
|
24
|
+
### Business Context
|
|
25
|
+
|
|
26
|
+
[2-3 paragraphs explaining why this project exists, the business problem being solved, and the strategic value to the organization]
|
|
27
|
+
|
|
28
|
+
### Objectives
|
|
29
|
+
|
|
30
|
+
[Bulleted list of 3-5 high-level objectives this project aims to achieve]
|
|
31
|
+
|
|
32
|
+
- [Objective 1]
|
|
33
|
+
- [Objective 2]
|
|
34
|
+
- [Objective 3]
|
|
35
|
+
|
|
36
|
+
### Expected Outcomes
|
|
37
|
+
|
|
38
|
+
[Measurable business outcomes - revenue impact, cost savings, efficiency gains, customer satisfaction, etc.]
|
|
39
|
+
|
|
40
|
+
- [Outcome 1 with metric]
|
|
41
|
+
- [Outcome 2 with metric]
|
|
42
|
+
- [Outcome 3 with metric]
|
|
43
|
+
|
|
44
|
+
### Project Scope
|
|
45
|
+
|
|
46
|
+
**In Scope**:
|
|
47
|
+
|
|
48
|
+
- [Capability/feature that IS included]
|
|
49
|
+
- [System/integration that IS included]
|
|
50
|
+
- [User group/persona that IS included]
|
|
51
|
+
|
|
52
|
+
**Out of Scope**:
|
|
53
|
+
|
|
54
|
+
- [Capability explicitly excluded]
|
|
55
|
+
- [Future phase work]
|
|
56
|
+
- [Related but separate initiative]
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
## Stakeholders
|
|
61
|
+
|
|
62
|
+
| Stakeholder | Role | Organization | Involvement Level |
|
|
63
|
+
|-------------|------|--------------|-------------------|
|
|
64
|
+
| [Name] | [Executive Sponsor] | [Dept] | Decision maker |
|
|
65
|
+
| [Name] | [Product Owner] | [Dept] | Requirements definition |
|
|
66
|
+
| [Name] | [Business Analyst] | [Dept] | Requirements elicitation |
|
|
67
|
+
| [Name] | [Enterprise Architect] | Architecture | Technical oversight |
|
|
68
|
+
| [Name] | [Security Lead] | Security | Security review |
|
|
69
|
+
| [Name] | [Compliance Officer] | Compliance | Regulatory compliance |
|
|
70
|
+
| [Name] | [End User Representative] | [Business Unit] | User acceptance |
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## Business Requirements
|
|
75
|
+
|
|
76
|
+
### BR-001: [Business Requirement Name]
|
|
77
|
+
|
|
78
|
+
**Description**: [What the business needs to achieve from a value perspective]
|
|
79
|
+
|
|
80
|
+
**Rationale**: [Why this is important to the business]
|
|
81
|
+
|
|
82
|
+
**Success Criteria**:
|
|
83
|
+
|
|
84
|
+
- [Measurable criterion 1]
|
|
85
|
+
- [Measurable criterion 2]
|
|
86
|
+
|
|
87
|
+
**Priority**: [MUST_HAVE | SHOULD_HAVE | COULD_HAVE | WONT_HAVE]
|
|
88
|
+
|
|
89
|
+
**Stakeholder**: [Who requested/owns this requirement]
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
### BR-002: [Business Requirement Name]
|
|
94
|
+
|
|
95
|
+
[Repeat structure above for each business requirement]
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
99
|
+
## Functional Requirements
|
|
100
|
+
|
|
101
|
+
### User Personas
|
|
102
|
+
|
|
103
|
+
#### Persona 1: [Persona Name]
|
|
104
|
+
|
|
105
|
+
- **Role**: [Job title/role]
|
|
106
|
+
- **Goals**: [What they want to accomplish]
|
|
107
|
+
- **Pain Points**: [Current challenges]
|
|
108
|
+
- **Technical Proficiency**: [Low | Medium | High]
|
|
109
|
+
|
|
110
|
+
#### Persona 2: [Persona Name]
|
|
111
|
+
|
|
112
|
+
[Repeat for each persona]
|
|
113
|
+
|
|
114
|
+
---
|
|
115
|
+
|
|
116
|
+
### Use Cases
|
|
117
|
+
|
|
118
|
+
#### UC-1: [Use Case Name]
|
|
119
|
+
|
|
120
|
+
**Actor**: [Primary user persona]
|
|
121
|
+
|
|
122
|
+
**Preconditions**:
|
|
123
|
+
|
|
124
|
+
- [System state before use case begins]
|
|
125
|
+
- [User permissions required]
|
|
126
|
+
|
|
127
|
+
**Main Flow**:
|
|
128
|
+
|
|
129
|
+
1. User [action 1]
|
|
130
|
+
2. System [response 1]
|
|
131
|
+
3. User [action 2]
|
|
132
|
+
4. System [response 2]
|
|
133
|
+
5. [Continue step-by-step flow]
|
|
134
|
+
|
|
135
|
+
**Postconditions**:
|
|
136
|
+
|
|
137
|
+
- [System state after successful completion]
|
|
138
|
+
- [Data changes that occurred]
|
|
139
|
+
|
|
140
|
+
**Alternative Flows**:
|
|
141
|
+
|
|
142
|
+
- **Alt 1a**: If [condition], then [alternative steps]
|
|
143
|
+
- **Alt 2a**: If [error condition], then [error handling]
|
|
144
|
+
|
|
145
|
+
**Exception Flows**:
|
|
146
|
+
|
|
147
|
+
- **Ex 1**: [Error scenario and system behavior]
|
|
148
|
+
|
|
149
|
+
**Business Rules**:
|
|
150
|
+
|
|
151
|
+
- [Rule 1 that governs this use case]
|
|
152
|
+
- [Rule 2 that constrains behavior]
|
|
153
|
+
|
|
154
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
155
|
+
|
|
156
|
+
---
|
|
157
|
+
|
|
158
|
+
### Functional Requirements Detail
|
|
159
|
+
|
|
160
|
+
#### FR-001: [Functional Requirement Name]
|
|
161
|
+
|
|
162
|
+
**Description**: [What the system must do]
|
|
163
|
+
|
|
164
|
+
**Relates To**: [BR-001, UC-1] (link to business requirements and use cases)
|
|
165
|
+
|
|
166
|
+
**Acceptance Criteria**:
|
|
167
|
+
|
|
168
|
+
- [ ] Given [context], when [action], then [expected result]
|
|
169
|
+
- [ ] Given [context], when [action], then [expected result]
|
|
170
|
+
- [ ] Edge case: [scenario and expected behavior]
|
|
171
|
+
|
|
172
|
+
**Data Requirements**:
|
|
173
|
+
|
|
174
|
+
- **Inputs**: [Data required for this function]
|
|
175
|
+
- **Outputs**: [Data produced by this function]
|
|
176
|
+
- **Validations**: [Data validation rules]
|
|
177
|
+
|
|
178
|
+
**Priority**: [MUST_HAVE | SHOULD_HAVE | COULD_HAVE | WONT_HAVE] (MoSCoW)
|
|
179
|
+
|
|
180
|
+
**Complexity**: [LOW | MEDIUM | HIGH]
|
|
181
|
+
|
|
182
|
+
**Dependencies**: [Other requirements this depends on]
|
|
183
|
+
|
|
184
|
+
**Assumptions**: [What we're assuming for this requirement]
|
|
185
|
+
|
|
186
|
+
---
|
|
187
|
+
|
|
188
|
+
#### FR-002: [Functional Requirement Name]
|
|
189
|
+
|
|
190
|
+
[Repeat for each functional requirement - aim for 10-30 FRs depending on project size]
|
|
191
|
+
|
|
192
|
+
---
|
|
193
|
+
|
|
194
|
+
## Non-Functional Requirements (NFRs)
|
|
195
|
+
|
|
196
|
+
### Performance Requirements
|
|
197
|
+
|
|
198
|
+
#### NFR-P-001: Response Time
|
|
199
|
+
|
|
200
|
+
**Requirement**: [Specific performance metric]
|
|
201
|
+
|
|
202
|
+
- Web page load time: < 2 seconds (95th percentile)
|
|
203
|
+
- API response time: < 200ms (95th percentile)
|
|
204
|
+
- Database query time: < 100ms (average)
|
|
205
|
+
|
|
206
|
+
**Measurement Method**: [How performance will be measured]
|
|
207
|
+
|
|
208
|
+
**Load Conditions**: [Expected concurrent users, transaction volume]
|
|
209
|
+
|
|
210
|
+
- Peak load: [X] concurrent users
|
|
211
|
+
- Average load: [Y] transactions per second
|
|
212
|
+
- Data volume: [Z] records in primary tables
|
|
213
|
+
|
|
214
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
215
|
+
|
|
216
|
+
---
|
|
217
|
+
|
|
218
|
+
#### NFR-P-002: Throughput
|
|
219
|
+
|
|
220
|
+
**Requirement**: System must handle [X] transactions per second at peak load
|
|
221
|
+
|
|
222
|
+
**Scalability**: Must scale horizontally to support 3x growth over 2 years
|
|
223
|
+
|
|
224
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
225
|
+
|
|
226
|
+
---
|
|
227
|
+
|
|
228
|
+
### Availability and Resilience Requirements
|
|
229
|
+
|
|
230
|
+
#### NFR-A-001: Availability Target
|
|
231
|
+
|
|
232
|
+
**Requirement**: System must achieve [99.9%] uptime (SLA)
|
|
233
|
+
|
|
234
|
+
- Maximum planned downtime: [X hours/month] for maintenance
|
|
235
|
+
- Maximum unplanned downtime: [Y hours/year]
|
|
236
|
+
|
|
237
|
+
**Maintenance Windows**: [Allowed times for planned maintenance]
|
|
238
|
+
|
|
239
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
240
|
+
|
|
241
|
+
---
|
|
242
|
+
|
|
243
|
+
#### NFR-A-002: Disaster Recovery
|
|
244
|
+
|
|
245
|
+
**RPO (Recovery Point Objective)**: Maximum acceptable data loss = [X minutes]
|
|
246
|
+
|
|
247
|
+
**RTO (Recovery Time Objective)**: Maximum acceptable downtime = [X hours]
|
|
248
|
+
|
|
249
|
+
**Backup Requirements**:
|
|
250
|
+
|
|
251
|
+
- Backup frequency: [Daily, hourly, continuous]
|
|
252
|
+
- Backup retention: [X days/months/years]
|
|
253
|
+
- Geographic backup location: [Region/datacenter requirements]
|
|
254
|
+
|
|
255
|
+
**Failover Requirements**:
|
|
256
|
+
|
|
257
|
+
- Automatic failover to secondary region: [YES | NO]
|
|
258
|
+
- Failover time: < [X minutes]
|
|
259
|
+
|
|
260
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
261
|
+
|
|
262
|
+
---
|
|
263
|
+
|
|
264
|
+
#### NFR-A-003: Fault Tolerance
|
|
265
|
+
|
|
266
|
+
**Requirement**: System must gracefully degrade when [component] fails
|
|
267
|
+
|
|
268
|
+
**Resilience Patterns Required**:
|
|
269
|
+
|
|
270
|
+
- [ ] Circuit breaker for external dependencies
|
|
271
|
+
- [ ] Retry with exponential backoff
|
|
272
|
+
- [ ] Timeout on all network calls
|
|
273
|
+
- [ ] Bulkhead isolation for critical resources
|
|
274
|
+
- [ ] Graceful degradation with reduced functionality
|
|
275
|
+
|
|
276
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
277
|
+
|
|
278
|
+
---
|
|
279
|
+
|
|
280
|
+
### Scalability Requirements
|
|
281
|
+
|
|
282
|
+
#### NFR-S-001: Horizontal Scaling
|
|
283
|
+
|
|
284
|
+
**Requirement**: System must support horizontal scaling without code changes
|
|
285
|
+
|
|
286
|
+
**Growth Projections**:
|
|
287
|
+
|
|
288
|
+
- Year 1: [X users, Y transactions/day]
|
|
289
|
+
- Year 2: [X users, Y transactions/day]
|
|
290
|
+
- Year 3: [X users, Y transactions/day]
|
|
291
|
+
|
|
292
|
+
**Scaling Triggers**: Auto-scale when CPU > 70% or memory > 80%
|
|
293
|
+
|
|
294
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
295
|
+
|
|
296
|
+
---
|
|
297
|
+
|
|
298
|
+
#### NFR-S-002: Data Volume Scaling
|
|
299
|
+
|
|
300
|
+
**Requirement**: System must handle data growth to [X TB] over [Y years]
|
|
301
|
+
|
|
302
|
+
**Data Archival Strategy**: [Hot/warm/cold storage tiers, archival after X months]
|
|
303
|
+
|
|
304
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
305
|
+
|
|
306
|
+
---
|
|
307
|
+
|
|
308
|
+
### Security Requirements
|
|
309
|
+
|
|
310
|
+
#### NFR-SEC-001: Authentication
|
|
311
|
+
|
|
312
|
+
**Requirement**: All users must authenticate via [SSO | OAuth 2.0 | SAML 2.0]
|
|
313
|
+
|
|
314
|
+
**Multi-Factor Authentication (MFA)**:
|
|
315
|
+
|
|
316
|
+
- Required for: [Admin users, privileged operations, external access]
|
|
317
|
+
- MFA methods: [Authenticator app, SMS, hardware token]
|
|
318
|
+
|
|
319
|
+
**Session Management**:
|
|
320
|
+
|
|
321
|
+
- Session timeout: [X minutes] of inactivity
|
|
322
|
+
- Absolute session timeout: [Y hours]
|
|
323
|
+
- Re-authentication required for: [sensitive operations]
|
|
324
|
+
|
|
325
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
326
|
+
|
|
327
|
+
---
|
|
328
|
+
|
|
329
|
+
#### NFR-SEC-002: Authorization
|
|
330
|
+
|
|
331
|
+
**Requirement**: Role-based access control (RBAC) with least privilege principle
|
|
332
|
+
|
|
333
|
+
**Roles and Permissions**: [Link to RACI matrix or detailed role definitions]
|
|
334
|
+
|
|
335
|
+
**Privilege Elevation**: [Process for temporary elevated access]
|
|
336
|
+
|
|
337
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
338
|
+
|
|
339
|
+
---
|
|
340
|
+
|
|
341
|
+
#### NFR-SEC-003: Data Encryption
|
|
342
|
+
|
|
343
|
+
**Requirement**:
|
|
344
|
+
|
|
345
|
+
- Data in transit: TLS 1.3+ with strong cipher suites
|
|
346
|
+
- Data at rest: AES-256 encryption for all data stores
|
|
347
|
+
- Key management: [AWS KMS | Azure Key Vault | HashiCorp Vault]
|
|
348
|
+
|
|
349
|
+
**Encryption Scope**:
|
|
350
|
+
|
|
351
|
+
- [ ] Database encryption at rest
|
|
352
|
+
- [ ] Backup encryption
|
|
353
|
+
- [ ] File storage encryption
|
|
354
|
+
- [ ] Application-level field encryption for PII
|
|
355
|
+
|
|
356
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
357
|
+
|
|
358
|
+
---
|
|
359
|
+
|
|
360
|
+
#### NFR-SEC-004: Secrets Management
|
|
361
|
+
|
|
362
|
+
**Requirement**: No secrets (API keys, passwords, certificates) in code or configuration files
|
|
363
|
+
|
|
364
|
+
**Secrets Storage**: [HashiCorp Vault | AWS Secrets Manager | Azure Key Vault]
|
|
365
|
+
|
|
366
|
+
**Secrets Rotation**: [Automatic rotation every X days]
|
|
367
|
+
|
|
368
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
369
|
+
|
|
370
|
+
---
|
|
371
|
+
|
|
372
|
+
#### NFR-SEC-005: Vulnerability Management
|
|
373
|
+
|
|
374
|
+
**Requirement**:
|
|
375
|
+
|
|
376
|
+
- Dependency scanning in CI/CD pipeline (no critical/high vulnerabilities)
|
|
377
|
+
- Static application security testing (SAST)
|
|
378
|
+
- Dynamic application security testing (DAST)
|
|
379
|
+
- Penetration testing: [Annually | Quarterly] by [internal | external] team
|
|
380
|
+
|
|
381
|
+
**Remediation SLA**:
|
|
382
|
+
|
|
383
|
+
- Critical vulnerabilities: [24 hours]
|
|
384
|
+
- High vulnerabilities: [7 days]
|
|
385
|
+
- Medium vulnerabilities: [30 days]
|
|
386
|
+
|
|
387
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
388
|
+
|
|
389
|
+
---
|
|
390
|
+
|
|
391
|
+
### Compliance and Regulatory Requirements
|
|
392
|
+
|
|
393
|
+
#### NFR-C-001: Data Privacy Compliance
|
|
394
|
+
|
|
395
|
+
**Applicable Regulations**: [GDPR | CCPA | HIPAA | PCI-DSS | SOX | FedRAMP]
|
|
396
|
+
|
|
397
|
+
**Compliance Requirements**:
|
|
398
|
+
|
|
399
|
+
- [ ] Data subject rights (access, deletion, portability)
|
|
400
|
+
- [ ] Consent management and audit trail
|
|
401
|
+
- [ ] Privacy by design and by default
|
|
402
|
+
- [ ] Data breach notification within [X hours]
|
|
403
|
+
- [ ] Data protection impact assessment (DPIA) completed
|
|
404
|
+
|
|
405
|
+
**Data Residency**: [EU data in EU, US data in US, etc.]
|
|
406
|
+
|
|
407
|
+
**Data Retention**: [Automatic deletion after X days/months/years]
|
|
408
|
+
|
|
409
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
410
|
+
|
|
411
|
+
---
|
|
412
|
+
|
|
413
|
+
#### NFR-C-002: Audit Logging
|
|
414
|
+
|
|
415
|
+
**Requirement**: Comprehensive audit trail for compliance and forensics
|
|
416
|
+
|
|
417
|
+
**Audit Log Contents** (for sensitive operations):
|
|
418
|
+
|
|
419
|
+
- Who: User/service identity
|
|
420
|
+
- What: Action performed
|
|
421
|
+
- When: Timestamp (UTC, millisecond precision)
|
|
422
|
+
- Where: System component
|
|
423
|
+
- Why: Context (request ID, transaction ID)
|
|
424
|
+
- Result: Success/failure with error details
|
|
425
|
+
|
|
426
|
+
**Log Retention**: [7 years] for compliance logs (immutable storage)
|
|
427
|
+
|
|
428
|
+
**Log Integrity**: Tamper-evident logging (cryptographic hashing)
|
|
429
|
+
|
|
430
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
431
|
+
|
|
432
|
+
---
|
|
433
|
+
|
|
434
|
+
#### NFR-C-003: Regulatory Reporting
|
|
435
|
+
|
|
436
|
+
**Requirement**: System must generate compliance reports for [specific regulations]
|
|
437
|
+
|
|
438
|
+
**Report Types**:
|
|
439
|
+
|
|
440
|
+
- [Report 1]: [Frequency, recipient, format]
|
|
441
|
+
- [Report 2]: [Frequency, recipient, format]
|
|
442
|
+
|
|
443
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
444
|
+
|
|
445
|
+
---
|
|
446
|
+
|
|
447
|
+
### Usability Requirements
|
|
448
|
+
|
|
449
|
+
#### NFR-U-001: User Experience
|
|
450
|
+
|
|
451
|
+
**Requirement**: System must be intuitive for users with [proficiency level]
|
|
452
|
+
|
|
453
|
+
**UX Standards**:
|
|
454
|
+
|
|
455
|
+
- Consistent with [Design System Name]
|
|
456
|
+
- Accessibility: WCAG 2.2 Level AA compliance
|
|
457
|
+
- Mobile responsive design
|
|
458
|
+
- Browser support: [Chrome, Firefox, Safari, Edge - last 2 versions]
|
|
459
|
+
|
|
460
|
+
**User Onboarding**: [Interactive tutorial, contextual help, documentation]
|
|
461
|
+
|
|
462
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
463
|
+
|
|
464
|
+
---
|
|
465
|
+
|
|
466
|
+
#### NFR-U-002: Accessibility
|
|
467
|
+
|
|
468
|
+
**Requirement**: WCAG 2.2 Level AA compliance
|
|
469
|
+
|
|
470
|
+
**Accessibility Features**:
|
|
471
|
+
|
|
472
|
+
- [ ] Keyboard navigation for all functions
|
|
473
|
+
- [ ] Screen reader compatibility
|
|
474
|
+
- [ ] High contrast mode
|
|
475
|
+
- [ ] Adjustable font sizes
|
|
476
|
+
- [ ] Alt text for images
|
|
477
|
+
- [ ] Captions for video/audio
|
|
478
|
+
|
|
479
|
+
**Testing**: Automated accessibility testing in CI/CD + manual testing
|
|
480
|
+
|
|
481
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
482
|
+
|
|
483
|
+
---
|
|
484
|
+
|
|
485
|
+
#### NFR-U-003: Localization and Internationalization
|
|
486
|
+
|
|
487
|
+
**Requirement**: Support for [list of languages and locales]
|
|
488
|
+
|
|
489
|
+
**Localization Scope**:
|
|
490
|
+
|
|
491
|
+
- [ ] UI text translation
|
|
492
|
+
- [ ] Date/time format per locale
|
|
493
|
+
- [ ] Currency formatting
|
|
494
|
+
- [ ] Number formatting
|
|
495
|
+
- [ ] Right-to-left (RTL) languages if applicable
|
|
496
|
+
|
|
497
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
498
|
+
|
|
499
|
+
---
|
|
500
|
+
|
|
501
|
+
### Maintainability and Supportability Requirements
|
|
502
|
+
|
|
503
|
+
#### NFR-M-001: Observability
|
|
504
|
+
|
|
505
|
+
**Requirement**: Comprehensive instrumentation for monitoring and troubleshooting
|
|
506
|
+
|
|
507
|
+
**Telemetry Requirements**:
|
|
508
|
+
|
|
509
|
+
- **Logging**: Structured JSON logs, centralized log aggregation
|
|
510
|
+
- **Metrics**: Prometheus-compatible, RED metrics (Rate, Errors, Duration)
|
|
511
|
+
- **Tracing**: Distributed tracing with OpenTelemetry
|
|
512
|
+
- **Dashboards**: Real-time operational dashboards for key metrics
|
|
513
|
+
- **Alerts**: SLO-based alerting with actionable runbooks
|
|
514
|
+
|
|
515
|
+
**Log Levels**: DEBUG, INFO, WARN, ERROR, FATAL
|
|
516
|
+
|
|
517
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
518
|
+
|
|
519
|
+
---
|
|
520
|
+
|
|
521
|
+
#### NFR-M-002: Documentation
|
|
522
|
+
|
|
523
|
+
**Requirement**: Comprehensive documentation for operators and developers
|
|
524
|
+
|
|
525
|
+
**Documentation Types**:
|
|
526
|
+
|
|
527
|
+
- [ ] Architecture documentation (C4 model)
|
|
528
|
+
- [ ] API documentation (OpenAPI 3.0 specs)
|
|
529
|
+
- [ ] Runbooks for operational procedures
|
|
530
|
+
- [ ] Troubleshooting guides
|
|
531
|
+
- [ ] User manuals
|
|
532
|
+
- [ ] Admin guides
|
|
533
|
+
|
|
534
|
+
**Documentation Format**: [Markdown in repo | Wiki | Confluence]
|
|
535
|
+
|
|
536
|
+
**Documentation Currency**: Updated within [X days] of code changes
|
|
537
|
+
|
|
538
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
539
|
+
|
|
540
|
+
---
|
|
541
|
+
|
|
542
|
+
#### NFR-M-003: Operational Runbooks
|
|
543
|
+
|
|
544
|
+
**Requirement**: Runbooks for common operational tasks and incident response
|
|
545
|
+
|
|
546
|
+
**Runbook Coverage**:
|
|
547
|
+
|
|
548
|
+
- [ ] Deployment procedures
|
|
549
|
+
- [ ] Rollback procedures
|
|
550
|
+
- [ ] Backup and restore procedures
|
|
551
|
+
- [ ] Incident response for common failure modes
|
|
552
|
+
- [ ] Scaling procedures (manual if not auto-scaled)
|
|
553
|
+
- [ ] Disaster recovery procedures
|
|
554
|
+
|
|
555
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
556
|
+
|
|
557
|
+
---
|
|
558
|
+
|
|
559
|
+
### Portability and Interoperability Requirements
|
|
560
|
+
|
|
561
|
+
#### NFR-I-001: API Standards
|
|
562
|
+
|
|
563
|
+
**Requirement**: All APIs must follow [OpenAPI 3.0 | GraphQL] standards
|
|
564
|
+
|
|
565
|
+
**API Design Principles**:
|
|
566
|
+
|
|
567
|
+
- RESTful design with standard HTTP methods
|
|
568
|
+
- JSON request/response format
|
|
569
|
+
- Versioning via URL path (e.g., /v1/, /v2/)
|
|
570
|
+
- Consistent error response format
|
|
571
|
+
- HATEOAS for discoverability (if applicable)
|
|
572
|
+
|
|
573
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
574
|
+
|
|
575
|
+
---
|
|
576
|
+
|
|
577
|
+
#### NFR-I-002: Integration Capabilities
|
|
578
|
+
|
|
579
|
+
**Requirement**: System must integrate with [list of external systems]
|
|
580
|
+
|
|
581
|
+
**Integration Patterns**:
|
|
582
|
+
|
|
583
|
+
- [ ] RESTful API integration
|
|
584
|
+
- [ ] Event-driven integration (pub/sub)
|
|
585
|
+
- [ ] File-based integration (SFTP, S3)
|
|
586
|
+
- [ ] Database replication
|
|
587
|
+
- [ ] Webhooks for real-time notifications
|
|
588
|
+
|
|
589
|
+
**Integration SLA**: [X% success rate, Y minute latency]
|
|
590
|
+
|
|
591
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
592
|
+
|
|
593
|
+
---
|
|
594
|
+
|
|
595
|
+
#### NFR-I-003: Data Portability
|
|
596
|
+
|
|
597
|
+
**Requirement**: Users/administrators must be able to export their data
|
|
598
|
+
|
|
599
|
+
**Export Formats**: [CSV, JSON, XML, PDF]
|
|
600
|
+
|
|
601
|
+
**Export Scope**: [Complete data export vs. filtered export]
|
|
602
|
+
|
|
603
|
+
**Import Capability**: [Support for bulk import from standard formats]
|
|
604
|
+
|
|
605
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
606
|
+
|
|
607
|
+
---
|
|
608
|
+
|
|
609
|
+
## Integration Requirements
|
|
610
|
+
|
|
611
|
+
### External System Integrations
|
|
612
|
+
|
|
613
|
+
#### INT-001: Integration with [System Name]
|
|
614
|
+
|
|
615
|
+
**Purpose**: [Why this integration is needed]
|
|
616
|
+
|
|
617
|
+
**Integration Type**: [Real-time API | Batch file transfer | Event-driven | Database sync]
|
|
618
|
+
|
|
619
|
+
**Data Exchanged**:
|
|
620
|
+
|
|
621
|
+
- **From [This System] to [External System]**: [Data entities and frequency]
|
|
622
|
+
- **From [External System] to [This System]**: [Data entities and frequency]
|
|
623
|
+
|
|
624
|
+
**Integration Pattern**: [Request/response | Pub/sub | Queue-based | etc.]
|
|
625
|
+
|
|
626
|
+
**Authentication**: [OAuth 2.0 | API key | Mutual TLS]
|
|
627
|
+
|
|
628
|
+
**Error Handling**: [Retry logic, dead letter queue, manual intervention]
|
|
629
|
+
|
|
630
|
+
**SLA**: [Latency, throughput, availability requirements]
|
|
631
|
+
|
|
632
|
+
**Owner**: [Team/person responsible for external system]
|
|
633
|
+
|
|
634
|
+
**Priority**: [CRITICAL | HIGH | MEDIUM | LOW]
|
|
635
|
+
|
|
636
|
+
---
|
|
637
|
+
|
|
638
|
+
#### INT-002: Integration with [Another System]
|
|
639
|
+
|
|
640
|
+
[Repeat structure for each external integration]
|
|
641
|
+
|
|
642
|
+
---
|
|
643
|
+
|
|
644
|
+
## Data Requirements
|
|
645
|
+
|
|
646
|
+
### Data Entities
|
|
647
|
+
|
|
648
|
+
#### Entity 1: [Entity Name]
|
|
649
|
+
|
|
650
|
+
**Description**: [What this entity represents]
|
|
651
|
+
|
|
652
|
+
**Attributes**:
|
|
653
|
+
| Attribute | Type | Required | Description | Constraints |
|
|
654
|
+
|-----------|------|----------|-------------|-------------|
|
|
655
|
+
| id | UUID | Yes | Unique identifier | Primary key |
|
|
656
|
+
| name | String(255) | Yes | Entity name | Not null, unique |
|
|
657
|
+
| created_at | Timestamp | Yes | Creation timestamp | Indexed |
|
|
658
|
+
| updated_at | Timestamp | Yes | Last update timestamp | Indexed |
|
|
659
|
+
| status | Enum | Yes | Entity status | ['active', 'inactive', 'archived'] |
|
|
660
|
+
|
|
661
|
+
**Relationships**:
|
|
662
|
+
|
|
663
|
+
- One-to-many with [Entity 2] via [foreign key]
|
|
664
|
+
- Many-to-many with [Entity 3] via [junction table]
|
|
665
|
+
|
|
666
|
+
**Data Volume**: [Estimated record count at Year 1, Year 3]
|
|
667
|
+
|
|
668
|
+
**Access Patterns**: [How data is typically queried - for indexing strategy]
|
|
669
|
+
|
|
670
|
+
**Data Classification**: [PUBLIC | INTERNAL | CONFIDENTIAL | RESTRICTED]
|
|
671
|
+
|
|
672
|
+
**Data Retention**: [Retention period before archival/deletion]
|
|
673
|
+
|
|
674
|
+
---
|
|
675
|
+
|
|
676
|
+
#### Entity 2: [Another Entity]
|
|
677
|
+
|
|
678
|
+
[Repeat for each major data entity]
|
|
679
|
+
|
|
680
|
+
---
|
|
681
|
+
|
|
682
|
+
### Data Quality Requirements
|
|
683
|
+
|
|
684
|
+
**Data Accuracy**: [Acceptable error rate, validation rules]
|
|
685
|
+
|
|
686
|
+
**Data Completeness**: [Required fields, null handling strategy]
|
|
687
|
+
|
|
688
|
+
**Data Consistency**: [Cross-system reconciliation requirements]
|
|
689
|
+
|
|
690
|
+
**Data Timeliness**: [Freshness requirements, acceptable staleness]
|
|
691
|
+
|
|
692
|
+
**Data Lineage**: [Tracking data source-to-target transformations]
|
|
693
|
+
|
|
694
|
+
---
|
|
695
|
+
|
|
696
|
+
### Data Migration Requirements
|
|
697
|
+
|
|
698
|
+
**Migration Scope**: [What data needs to be migrated from legacy systems]
|
|
699
|
+
|
|
700
|
+
**Migration Strategy**: [Big bang | Phased | Parallel run]
|
|
701
|
+
|
|
702
|
+
**Data Transformation**: [Required transformations during migration]
|
|
703
|
+
|
|
704
|
+
**Data Validation**: [How to verify migration success]
|
|
705
|
+
|
|
706
|
+
**Rollback Plan**: [How to revert if migration fails]
|
|
707
|
+
|
|
708
|
+
**Migration Timeline**: [Estimated duration, blackout windows]
|
|
709
|
+
|
|
710
|
+
---
|
|
711
|
+
|
|
712
|
+
## Constraints and Assumptions
|
|
713
|
+
|
|
714
|
+
### Technical Constraints
|
|
715
|
+
|
|
716
|
+
**TC-1**: [Constraint description - e.g., Must integrate with existing authentication system]
|
|
717
|
+
|
|
718
|
+
**TC-2**: [Constraint description - e.g., Must deploy to existing AWS account]
|
|
719
|
+
|
|
720
|
+
**TC-3**: [Constraint description - e.g., Must use approved technology stack]
|
|
721
|
+
|
|
722
|
+
---
|
|
723
|
+
|
|
724
|
+
### Business Constraints
|
|
725
|
+
|
|
726
|
+
**BC-1**: [Constraint description - e.g., Go-live date cannot slip due to regulatory deadline]
|
|
727
|
+
|
|
728
|
+
**BC-2**: [Constraint description - e.g., Budget cap of $X]
|
|
729
|
+
|
|
730
|
+
**BC-3**: [Constraint description - e.g., Must use existing vendor for hosting]
|
|
731
|
+
|
|
732
|
+
---
|
|
733
|
+
|
|
734
|
+
### Assumptions
|
|
735
|
+
|
|
736
|
+
**A-1**: [Assumption - e.g., Users will have modern browsers with JavaScript enabled]
|
|
737
|
+
|
|
738
|
+
**A-2**: [Assumption - e.g., External API will maintain backward compatibility]
|
|
739
|
+
|
|
740
|
+
**A-3**: [Assumption - e.g., Network latency to external system < 50ms]
|
|
741
|
+
|
|
742
|
+
**Validation Plan**: [How assumptions will be validated during project]
|
|
743
|
+
|
|
744
|
+
---
|
|
745
|
+
|
|
746
|
+
## Success Criteria and KPIs
|
|
747
|
+
|
|
748
|
+
### Business Success Metrics
|
|
749
|
+
|
|
750
|
+
| Metric | Baseline | Target | Timeline | Measurement Method |
|
|
751
|
+
|--------|----------|--------|----------|-------------------|
|
|
752
|
+
| [Metric 1] | [Current value] | [Target value] | [When] | [How measured] |
|
|
753
|
+
| [Metric 2] | [Current value] | [Target value] | [When] | [How measured] |
|
|
754
|
+
| [Metric 3] | [Current value] | [Target value] | [When] | [How measured] |
|
|
755
|
+
|
|
756
|
+
**Examples**:
|
|
757
|
+
|
|
758
|
+
- Revenue impact: Increase sales by 15% within 6 months
|
|
759
|
+
- Cost reduction: Reduce operational costs by $500K annually
|
|
760
|
+
- Customer satisfaction: Improve NPS from 45 to 65 within 1 year
|
|
761
|
+
- Process efficiency: Reduce task completion time from 10 minutes to 3 minutes
|
|
762
|
+
|
|
763
|
+
---
|
|
764
|
+
|
|
765
|
+
### Technical Success Metrics
|
|
766
|
+
|
|
767
|
+
| Metric | Target | Measurement Method |
|
|
768
|
+
|--------|--------|-------------------|
|
|
769
|
+
| System availability | 99.9% | Uptime monitoring |
|
|
770
|
+
| API response time (p95) | < 200ms | APM tooling |
|
|
771
|
+
| Error rate | < 0.1% | Log aggregation |
|
|
772
|
+
| Deployment frequency | Daily | CI/CD metrics |
|
|
773
|
+
| Mean time to recovery (MTTR) | < 15 minutes | Incident tracking |
|
|
774
|
+
|
|
775
|
+
---
|
|
776
|
+
|
|
777
|
+
### User Adoption Metrics
|
|
778
|
+
|
|
779
|
+
| Metric | Target | Timeline | Measurement Method |
|
|
780
|
+
|--------|--------|----------|-------------------|
|
|
781
|
+
| Active users | [X users] | [3 months post-launch] | Analytics platform |
|
|
782
|
+
| Feature adoption rate | [Y%] | [6 months post-launch] | Usage analytics |
|
|
783
|
+
| User satisfaction score | [Z/10] | [Ongoing] | User surveys |
|
|
784
|
+
|
|
785
|
+
---
|
|
786
|
+
|
|
787
|
+
## Dependencies and Risks
|
|
788
|
+
|
|
789
|
+
### Dependencies
|
|
790
|
+
|
|
791
|
+
| Dependency | Description | Owner | Target Date | Status | Impact if Delayed |
|
|
792
|
+
|------------|-------------|-------|-------------|--------|-------------------|
|
|
793
|
+
| [Dependency 1] | [Description] | [Team/Person] | [Date] | [On Track | At Risk | Blocked] | [HIGH | MEDIUM | LOW] |
|
|
794
|
+
| [Dependency 2] | [Description] | [Team/Person] | [Date] | [On Track | At Risk | Blocked] | [HIGH | MEDIUM | LOW] |
|
|
795
|
+
|
|
796
|
+
---
|
|
797
|
+
|
|
798
|
+
### Risks
|
|
799
|
+
|
|
800
|
+
| Risk ID | Description | Probability | Impact | Mitigation Strategy | Owner |
|
|
801
|
+
|---------|-------------|-------------|--------|---------------------|-------|
|
|
802
|
+
| R-1 | [Risk description] | [HIGH | MEDIUM | LOW] | [HIGH | MEDIUM | LOW] | [Mitigation actions] | [Owner] |
|
|
803
|
+
| R-2 | [Risk description] | [HIGH | MEDIUM | LOW] | [HIGH | MEDIUM | LOW] | [Mitigation actions] | [Owner] |
|
|
804
|
+
|
|
805
|
+
**Risk Scoring**: Probability × Impact = Risk Level
|
|
806
|
+
|
|
807
|
+
- High Risk (Red): Requires executive escalation
|
|
808
|
+
- Medium Risk (Yellow): Active monitoring and mitigation
|
|
809
|
+
- Low Risk (Green): Accepted
|
|
810
|
+
|
|
811
|
+
---
|
|
812
|
+
|
|
813
|
+
## Requirement Conflicts & Resolutions
|
|
814
|
+
|
|
815
|
+
> **Purpose**: Document conflicting requirements that arise from competing stakeholder drivers and show how conflicts were resolved.
|
|
816
|
+
>
|
|
817
|
+
> **Source**: Conflicts often originate from stakeholder analysis (see `ARC-{PROJECT_ID}-STKE-v*.md` conflict analysis section).
|
|
818
|
+
>
|
|
819
|
+
> **Principle**: Be transparent about trade-offs - don't hide conflicts or pretend both requirements can be fully satisfied.
|
|
820
|
+
|
|
821
|
+
### Conflict C-1: [Conflict Name]
|
|
822
|
+
|
|
823
|
+
**Conflicting Requirements**:
|
|
824
|
+
|
|
825
|
+
- **Requirement A**: [Requirement ID and description] (e.g., FR-001: Launch MVP in 3 months)
|
|
826
|
+
- **Requirement B**: [Requirement ID and description] (e.g., NFR-Q-001: 95% test coverage before launch)
|
|
827
|
+
|
|
828
|
+
**Stakeholders Involved**:
|
|
829
|
+
|
|
830
|
+
- **Stakeholder A** (e.g., CEO): Wants Requirement A because [driver/goal] (e.g., competitive pressure, Q2 revenue target)
|
|
831
|
+
- **Stakeholder B** (e.g., CTO): Wants Requirement B because [driver/goal] (e.g., quality reputation, reduce production bugs)
|
|
832
|
+
|
|
833
|
+
**Nature of Conflict**:
|
|
834
|
+
|
|
835
|
+
- [Explain why both cannot be fully satisfied]
|
|
836
|
+
- Example: "3-month timeline insufficient to achieve 95% coverage and build all planned features"
|
|
837
|
+
|
|
838
|
+
**Trade-off Analysis**:
|
|
839
|
+
|
|
840
|
+
| Option | Pros | Cons | Impact |
|
|
841
|
+
|--------|------|------|--------|
|
|
842
|
+
| **Option 1**: Prioritize Speed (Launch in 3 months with 70% coverage) | ✅ Meet market window<br>✅ Early revenue | ❌ Higher bug risk<br>❌ Technical debt | CEO happy<br>CTO concerned |
|
|
843
|
+
| **Option 2**: Prioritize Quality (6 month launch with 95% coverage) | ✅ Quality reputation<br>✅ Lower production bugs | ❌ Miss market window<br>❌ Delayed revenue | CTO happy<br>CEO frustrated |
|
|
844
|
+
| **Option 3**: Compromise (4 months, 85% coverage, reduced scope) | ✅ Balance speed/quality<br>✅ Partial satisfaction | ❌ Neither fully satisfied<br>❌ Feature cuts needed | Both somewhat satisfied |
|
|
845
|
+
| **Option 4**: Innovate (3 months, automated testing, pair programming) | ✅ Speed AND quality<br>✅ Both satisfied | ❌ Higher upfront cost<br>❌ Team training needed | Both satisfied if works |
|
|
846
|
+
|
|
847
|
+
**Resolution Strategy**: [PRIORITIZE | COMPROMISE | PHASE | INNOVATE]
|
|
848
|
+
|
|
849
|
+
**Decision**: [What was chosen]
|
|
850
|
+
|
|
851
|
+
- Example: "Option 3 - Compromise: 4-month launch with 85% test coverage and reduced MVP scope"
|
|
852
|
+
|
|
853
|
+
**Rationale**: [Why this decision was made]
|
|
854
|
+
|
|
855
|
+
- Example: "Board approved 1-month timeline extension. CEO accepted delay for quality. CTO accepted 85% coverage threshold with commitment to reach 95% post-launch."
|
|
856
|
+
|
|
857
|
+
**Decision Authority**: [Who made the final decision]
|
|
858
|
+
|
|
859
|
+
- Reference stakeholder analysis RACI matrix
|
|
860
|
+
- Example: "Executive Sponsor (CEO) with input from Steering Committee"
|
|
861
|
+
|
|
862
|
+
**Impact on Requirements**:
|
|
863
|
+
|
|
864
|
+
- **Modified**: FR-001 changed from "3 months" to "4 months"
|
|
865
|
+
- **Modified**: NFR-Q-001 changed from "95% coverage" to "85% coverage at launch, 95% within 3 months post-launch"
|
|
866
|
+
- **Removed**: FR-015, FR-022, FR-031 (deferred to Phase 2)
|
|
867
|
+
|
|
868
|
+
**Stakeholder Management**:
|
|
869
|
+
|
|
870
|
+
- **CEO (Lost timeline)**: Communicated market analysis showing 4-month launch still captures 80% of opportunity. Committed to weekly progress updates.
|
|
871
|
+
- **CTO (Lost full coverage)**: Committed to post-launch quality sprint. Added NFR-Q-002: "Reach 95% coverage within 3 months of launch"
|
|
872
|
+
|
|
873
|
+
**Future Consideration**:
|
|
874
|
+
|
|
875
|
+
- Re-evaluate coverage target after 3 months of production data
|
|
876
|
+
- Deferred features (FR-015, FR-022, FR-031) prioritized for Phase 2
|
|
877
|
+
|
|
878
|
+
---
|
|
879
|
+
|
|
880
|
+
### Conflict C-2: [Another Conflict]
|
|
881
|
+
|
|
882
|
+
[Repeat structure for each conflict]
|
|
883
|
+
|
|
884
|
+
**Common Conflict Patterns**:
|
|
885
|
+
|
|
886
|
+
1. **Speed vs Quality**: Fast delivery vs thorough testing/documentation
|
|
887
|
+
- Resolution strategies: MVP/phased, automated testing, pair programming
|
|
888
|
+
|
|
889
|
+
2. **Cost vs Features**: Budget constraints vs feature richness
|
|
890
|
+
- Resolution strategies: prioritize must-haves, defer nice-to-haves, open-source alternatives
|
|
891
|
+
|
|
892
|
+
3. **Security vs Usability**: Strong security vs seamless user experience
|
|
893
|
+
- Resolution strategies: risk-based controls, adaptive authentication, user segmentation
|
|
894
|
+
|
|
895
|
+
4. **Flexibility vs Standardization**: Custom solutions vs standard platforms
|
|
896
|
+
- Resolution strategies: configurable platforms, plugin architecture, standard + exceptions process
|
|
897
|
+
|
|
898
|
+
5. **Innovation vs Stability**: New technology vs proven technology
|
|
899
|
+
- Resolution strategies: pilot projects, hybrid approach, gradual migration
|
|
900
|
+
|
|
901
|
+
6. **Global vs Local**: Centralized control vs regional autonomy
|
|
902
|
+
- Resolution strategies: federated model, global policies + local implementation, regional opt-ins
|
|
903
|
+
|
|
904
|
+
---
|
|
905
|
+
|
|
906
|
+
## Timeline and Milestones
|
|
907
|
+
|
|
908
|
+
### High-Level Milestones
|
|
909
|
+
|
|
910
|
+
| Milestone | Description | Target Date | Dependencies |
|
|
911
|
+
|-----------|-------------|-------------|--------------|
|
|
912
|
+
| Requirements Approval | Stakeholder sign-off on requirements | [DATE] | This document |
|
|
913
|
+
| Design Complete | HLD and DLD approved | [DATE] | Requirements |
|
|
914
|
+
| Development Complete | Code complete, tests passing | [DATE] | Design |
|
|
915
|
+
| UAT Complete | User acceptance testing passed | [DATE] | Development |
|
|
916
|
+
| Production Launch | Go-live | [DATE] | UAT |
|
|
917
|
+
|
|
918
|
+
---
|
|
919
|
+
|
|
920
|
+
## Budget
|
|
921
|
+
|
|
922
|
+
### Cost Estimate
|
|
923
|
+
|
|
924
|
+
| Category | Estimated Cost | Notes |
|
|
925
|
+
|----------|----------------|-------|
|
|
926
|
+
| Development | $[X] | [FTE count, duration] |
|
|
927
|
+
| Infrastructure | $[X] | [Cloud resources, licenses] |
|
|
928
|
+
| Third-party services | $[X] | [APIs, SaaS subscriptions] |
|
|
929
|
+
| Testing | $[X] | [Performance testing tools, security testing] |
|
|
930
|
+
| Training | $[X] | [User training, documentation] |
|
|
931
|
+
| **Total** | **$[TOTAL]** | |
|
|
932
|
+
|
|
933
|
+
### Ongoing Operational Costs
|
|
934
|
+
|
|
935
|
+
| Category | Annual Cost | Notes |
|
|
936
|
+
|----------|-------------|-------|
|
|
937
|
+
| Infrastructure | $[X/year] | [Cloud hosting, scaling] |
|
|
938
|
+
| Licenses | $[X/year] | [Software licenses, SaaS] |
|
|
939
|
+
| Support | $[X/year] | [Maintenance, on-call] |
|
|
940
|
+
| **Total** | **$[TOTAL/year]** | |
|
|
941
|
+
|
|
942
|
+
---
|
|
943
|
+
|
|
944
|
+
## Approval
|
|
945
|
+
|
|
946
|
+
### Requirements Review
|
|
947
|
+
|
|
948
|
+
| Reviewer | Role | Status | Date | Comments |
|
|
949
|
+
|----------|------|--------|------|----------|
|
|
950
|
+
| [Name] | Business Sponsor | [ ] Approved | [DATE] | |
|
|
951
|
+
| [Name] | Product Owner | [ ] Approved | [DATE] | |
|
|
952
|
+
| [Name] | Enterprise Architect | [ ] Approved | [DATE] | |
|
|
953
|
+
| [Name] | Security | [ ] Approved | [DATE] | |
|
|
954
|
+
| [Name] | Compliance | [ ] Approved | [DATE] | |
|
|
955
|
+
|
|
956
|
+
### Sign-Off
|
|
957
|
+
|
|
958
|
+
By signing below, stakeholders confirm that requirements are complete, understood, and approved to proceed to design phase.
|
|
959
|
+
|
|
960
|
+
| Stakeholder | Signature | Date |
|
|
961
|
+
|-------------|-----------|------|
|
|
962
|
+
| [Name, Role] | _________ | [DATE] |
|
|
963
|
+
| [Name, Role] | _________ | [DATE] |
|
|
964
|
+
|
|
965
|
+
---
|
|
966
|
+
|
|
967
|
+
## Appendices
|
|
968
|
+
|
|
969
|
+
### Appendix A: Glossary
|
|
970
|
+
|
|
971
|
+
[Define domain-specific terms, acronyms, and abbreviations]
|
|
972
|
+
|
|
973
|
+
### Appendix B: Reference Documents
|
|
974
|
+
|
|
975
|
+
- [Link to architecture principles]
|
|
976
|
+
- [Link to related projects]
|
|
977
|
+
- [Link to existing system documentation]
|
|
978
|
+
|
|
979
|
+
### Appendix C: Wireframes and Mockups
|
|
980
|
+
|
|
981
|
+
[Link to design artifacts if applicable]
|
|
982
|
+
|
|
983
|
+
### Appendix D: Data Models
|
|
984
|
+
|
|
985
|
+
[Detailed ERD or UML diagrams if complex]
|
|
986
|
+
|
|
987
|
+
---
|
|
988
|
+
|
|
989
|
+
**Document History**
|
|
990
|
+
|
|
991
|
+
| Version | Date | Author | Changes |
|
|
992
|
+
|---------|------|--------|---------|
|
|
993
|
+
| 0.1 | [DATE] | [AUTHOR] | Initial draft |
|
|
994
|
+
| 0.2 | [DATE] | [AUTHOR] | [Stakeholder feedback incorporated] |
|
|
995
|
+
| 1.0 | [DATE] | [AUTHOR] | Approved version |
|
|
996
|
+
|
|
997
|
+
## External References
|
|
998
|
+
|
|
999
|
+
> This section provides traceability from generated content back to source documents.
|
|
1000
|
+
> Follow citation instructions in the project's citation reference guide.
|
|
1001
|
+
|
|
1002
|
+
### Document Register
|
|
1003
|
+
|
|
1004
|
+
| Doc ID | Filename | Type | Source Location | Description |
|
|
1005
|
+
|--------|----------|------|-----------------|-------------|
|
|
1006
|
+
| *None provided* | — | — | — | — |
|
|
1007
|
+
|
|
1008
|
+
### Citations
|
|
1009
|
+
|
|
1010
|
+
| Citation ID | Doc ID | Page/Section | Category | Quoted Passage |
|
|
1011
|
+
|-------------|--------|--------------|----------|----------------|
|
|
1012
|
+
| — | — | — | — | — |
|
|
1013
|
+
|
|
1014
|
+
### Unreferenced Documents
|
|
1015
|
+
|
|
1016
|
+
| Filename | Source Location | Reason |
|
|
1017
|
+
|----------|-----------------|--------|
|
|
1018
|
+
| — | — | — |
|
|
1019
|
+
|
|
1020
|
+
---
|
|
1021
|
+
|
|
1022
|
+
**Generated by**: ArcKit `/arckit:requirements` command
|
|
1023
|
+
**Generated on**: [DATE]
|
|
1024
|
+
**ArcKit Version**: [VERSION]
|
|
1025
|
+
**Project**: [PROJECT_NAME]
|
|
1026
|
+
**Model**: [AI_MODEL]
|