From 2ae5fa0930c64b2ae008be539459101791babfc4 Mon Sep 17 00:00:00 2001 From: Albrecht Degering Date: Fri, 10 Jul 2026 12:51:19 +0200 Subject: [PATCH] chore: sync GovOPlaN module split state --- README.md | 11 +++++++ docs/DMS_BOUNDARY.md | 70 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 81 insertions(+) create mode 100644 README.md create mode 100644 docs/DMS_BOUNDARY.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..b5f5205 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# GovOPlaN DMS + +`govoplan-dms` owns document lifecycle and collaborative document-management +semantics. It builds on files/storage providers but does not own low-level file +storage or file connector implementations. + +This repository is currently a tag-only scaffold. It should gain package +metadata and module manifests only after the first backend or WebUI slice is +designed. + +See [docs/DMS_BOUNDARY.md](docs/DMS_BOUNDARY.md) for the boundary decision. diff --git a/docs/DMS_BOUNDARY.md b/docs/DMS_BOUNDARY.md new file mode 100644 index 0000000..b6b5193 --- /dev/null +++ b/docs/DMS_BOUNDARY.md @@ -0,0 +1,70 @@ +# DMS Module Boundary + +`govoplan-dms` owns document lifecycle, collaboration, document evidence, and +document governance. Files remain lower-level storage and provider integration. + +The core boundary decision register is in +`/mnt/DATA/git/govoplan-core/docs/MODULE_ARCHITECTURE.md`. + +## Ownership + +DMS owns: + +- document records, versions, renditions, and document metadata +- collaborative editing links and external office-suite session references +- comments, reviews, approvals, locks, signatures, and checkout/checkin +- document classification, retention inputs, legal hold, and archive handoff +- document evidence references for cases, workflow, templates, forms, mail, and + reporting +- external DMS/e-file/archive links and selected metadata synchronization where + a connector provides the protocol boundary + +## Boundary With Files + +`govoplan-files` owns: + +- stored file objects and blob/provider storage +- file upload/download, file permissions, file spaces, and provider connectors +- checksums, MIME type, file size, and low-level file metadata + +DMS should reference file objects through file capabilities and DTOs. It must +not import file connector internals. A document version may point to a +GovOPlaN-managed file, an external DMS object, or both. + +## External Collaboration + +Office/collaboration suites such as Collabora, OnlyOffice, Nextcloud Office, or +OpenDesk document services should be integrated through connectors or +capabilities. DMS owns the document session semantics and evidence; connectors +own endpoint/profile health and protocol-specific clients. + +## Integrations + +- `govoplan-templates`: generates initial document content or rendered outputs +- `govoplan-forms`: supplies submission data and attachment references +- `govoplan-workflow` and `govoplan-cases`: attach documents to process state + and evidence +- `govoplan-mail` and `govoplan-postbox`: send or expose document references +- `govoplan-reporting`: exports reports as document evidence where needed +- `govoplan-records`: classifies closed documents into file plans and archive + handoff + +## Candidate Capabilities + +- `dms.documents` +- `dms.versions` +- `dms.collaboration` +- `dms.approvals` +- `dms.locks` +- `dms.legalHold` +- `dms.externalReferences` + +## First Implementation Slice + +1. Define manifest metadata, permissions, and capability names. +2. Add document/version/reference DTOs. +3. Add one file-backed document version path through the files capability. +4. Add locks and approval status as explicit document state, even if the first + implementation is simple. +5. Add tests that DMS can run without external office-suite connectors and that + optional file integration uses capabilities.