Files
govoplan-files/docs/DOCUMENT_COLLABORATION_BOUNDARY.md

55 lines
2.4 KiB
Markdown

# Document Collaboration Boundary
GovOPlaN Files is the governed managed-file module. It stores uploaded/imported
blobs, versions, shares, provenance, ZIP imports/exports, connector imports, and
campaign attachment evidence. It should stay reliable, auditable, and simple.
Collaborative document behavior should be owned by a future documents module or
by provider-specific connector modules when the behavior is delegated to systems
such as Nextcloud, Seafile, Collabora, OnlyOffice, OpenDesk, or DMS/eAkte
platforms.
## Files Owns
- managed blobs and immutable version evidence
- owner-scoped user/group file spaces
- shares and access checks for managed files
- connector browse/import into managed storage
- source provenance, source revision, and audit events
- freeze-before-send campaign attachment behavior
- previews generated from managed file versions
## Documents Or Connectors Should Own
- co-editing sessions and editor launch URLs
- comments, suggestions, document tasks, and review state
- check-in/check-out, remote locks, and lock timeouts
- semantic document versions beyond blob versions
- template merge flows and generated-document lifecycle
- external DMS metadata, filing plans, record categories, and retention classes
- provider-specific sync state and conflict resolution
- collaborative presence and notification behavior
## Integration Shape
The documents layer should integrate with files through stable contracts:
- create or import a managed file version for evidence points
- attach source provenance when a file came from an external editor or DMS
- ask files for read/download access rather than importing files internals
- emit workflow/audit events when a collaborative document reaches a governed
state such as reviewed, approved, frozen, sent, or archived
- use connector providers for provider-specific browse/import/write behavior
Files may expose links to a document or connector module, but it should not own
the collaboration state machine. A collaborative document can produce many
working states; GovOPlaN Files should persist the governed snapshots that other
modules can safely use as evidence.
## Practical Rule
If a feature is about storing, sharing, importing, downloading, or freezing a
file, it belongs in `govoplan-files`. If a feature is about people jointly
editing, reviewing, locking, commenting on, or routing a document through a
semantic process, it belongs in a documents/workflow/DMS integration module.