diff --git a/AGENTS.md b/AGENTS.md index d72b5b7..370e287 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,5 +1,11 @@ # GovOPlaN Records Codex Guide +## Documentation Contract + +- Treat documentation as part of every behavior change. Update this module's manifest-driven `DocumentationTopic` contributions for affected user and administrator behavior. +- Keep feature content here; `govoplan-docs` projects it without importing Records internals. +- Maintain a static user/admin baseline and run `/mnt/DATA/git/govoplan/tools/checks/check-manifest-shapes.py` after behavior or manifest changes. + ## Scope This repository owns the GovOPlaN Records platform module seed. diff --git a/src/govoplan_records/backend/manifest.py b/src/govoplan_records/backend/manifest.py index 0da6a68..2663fa8 100644 --- a/src/govoplan_records/backend/manifest.py +++ b/src/govoplan_records/backend/manifest.py @@ -2,6 +2,7 @@ from __future__ import annotations from govoplan_core.core.access import CAPABILITY_AUTH_PERMISSION_EVALUATOR, CAPABILITY_AUTH_PRINCIPAL_RESOLVER from govoplan_core.core.modules import DocumentationLink, DocumentationTopic, ModuleManifest, PermissionDefinition, RoleTemplate +from govoplan_core.core.provider_governance import declared_module_architecture MODULE_ID = "records" MODULE_NAME = "Records" @@ -65,8 +66,8 @@ DOCUMENTATION = ( "database models, migrations, and WebUI routes are introduced." ), layer="available", - documentation_types=("admin",), - audience=("operator", "module_admin", "product_owner"), + documentation_types=("admin", "user"), + audience=("user", "operator", "module_admin", "product_owner"), order=100, related_modules=OPTIONAL_DEPENDENCIES, links=( @@ -94,6 +95,15 @@ manifest = ModuleManifest( permissions=PERMISSIONS, role_templates=ROLE_TEMPLATES, documentation=DOCUMENTATION, + architecture=declared_module_architecture( + layer="content_records_evidence", + kind="domain", + maturity="scaffold", + documentation_ref="docs/RECORDS_DOMAIN_BOUNDARY.md", + known_limits=("Record declaration, retention, hold, transfer, and disposal are not implemented yet.",), + owned_concepts=("record", "record classification", "disposition"), + non_owned_concepts=("file content", "audit event", "domain object"), + ), )