Content
View differences
Updated by Wieland Lindenthal 8 months ago
**As** a user
**I want to** have some useful types to organize my documents for creating a directly edited, collaborative document
**so that** I can communicate easier the purpose of a document better use documents for standard use cases
**Goals**
* Simplify naming of documents (don't repeat the type in the title)
* Make it simpler to find a document (... via filtering)
* In future versions we plan to use types to add specific
* workflows, having specific statuses workflows
* template content
* Support for sign-off processes
* Allow other tools, e.g. magic AI agents, to create certain types. content
<br>
**Acceptance criteria**
* Document Seed document types get (same as seeded in for categories)
* **Documentation (knowing that it overlaps with purpose of the team's language.
Wiki module)**
* If current number of **Specification**
* ~~Other~~ (--> General Document)
* Seed additional document types is 3 or less then seed all types listed below that do not already exist.
* Explanation: The latest version Basic document/Simple document//None/General/Unspecific/Random/No type
* **Note**
* **Report**
* **Manual (knowing that it overlaps with purpose of the seeder seeded 3 categories (Documentation, Specification, Other) Wiki module)**
* **Analysis**
* **Protocol (knowing that overlaps with purpose of Meetings module)**
* ~~**FAQ**~~ **(is better stored in the seeding language. a Wiki)**
* Contract
* If there is a type called "Other" (or a translation in their team's language) AND there are no documents stored on the instance having that type then remove that type.
**Types and Translations** Alphabetical order of types
* Note
* General Document
* Specification
* Documentation
* Protocol
* Report
* Manual
* Analysis
**Translations**
In this order:
<figure class="table op-uc-figure_align-center op-uc-figure"><table class="op-uc-table"><thead class="op-uc-table--head"><tr class="op-uc-table--row"><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">Document Type</p></th><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">Description</p></th><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">German Translation</p></th><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">French Translation</p></th><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">Spanish Translation</p></th></tr></thead><tbody><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p">General Document</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Default or fallback type for documents that don’t fit other categories.</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Allgemeines Dokument</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Document général</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Documento general</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p">Note</p></td><td class="op-uc-table--cell"><p class="op-uc-p"><strong>Default</strong> - Informal class="op-uc-p">Informal or lightweight document for ideas, observations, or drafts.</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Notiz</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Note</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Nota</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p">Idea</p></td><td class="op-uc-p">Report</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Summarizes progress, results, or findings.</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Bericht</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Rapport</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Informe</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p">Plan</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Outlines steps, timelines, or responsibilities.</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Idee</p></td><td class="op-uc-p">Plan</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Idée</p></td><td class="op-uc-p">Plan</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Idea</p></td></tr><tr class="op-uc-p">Plan</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p">Specification</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Defines requirements, scope, or system behavior.</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Spezifikation</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Spécification</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Especificación</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p">Documentation</p></td><td class="op-uc-table--cell"><p class="op-uc-p">General technical or project documentation not covered elsewhere.</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Dokumentation</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Documentation</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Documentación</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p">Protocol</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Describes procedures, decisions, or meeting outcomes.</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Protokoll</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Procès-verbal / Protocole</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Protocolo</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p">Analysis</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Provides evaluation or assessment of data or options.</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Analyse</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Analyse</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Análisis</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p">Proposal</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Suggests an initiative or change for approval.</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Antrag</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Proposition</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Propuesta</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p">Specification</p></td><td class="op-uc-p">Guideline</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Defines requirements, scope, rules, standards, or system behavior.</p></td><td best practices.</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Spezifikation</p></td><td class="op-uc-p">Richtlinie</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Spécification</p></td><td class="op-uc-p">Directive</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Especificación</p></td></tr><tr class="op-uc-p">Directriz</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p">Report</p></td><td class="op-uc-p">Manual</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Summarizes progress, results, class="op-uc-p">Offers instructions for usage, setup, or findings.</p></td><td maintenance.</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Bericht</p></td><td class="op-uc-p">Anleitung</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Rapport</p></td><td class="op-uc-p">Manuel</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Informe</p></td></tr><tr class="op-uc-p">Instrucciones</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p">Documentation</p></td><td class="op-uc-p">Template</p></td><td class="op-uc-table--cell"><p class="op-uc-p">General technical class="op-uc-p">Provides a reusable structure for repeated tasks or project documentation not covered elsewhere.</p></td><td documents.</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Dokumentation</p></td><td class="op-uc-p">Vorlage</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Documentation</p></td><td class="op-uc-p">Modèle</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Documentación</p></td></tr></tbody></table></figure> class="op-uc-p">Plantilla</p></td></tr></tbody></table></figure>
**Out of scope**
* Migrating Document categories to types (Migration need to run before seeding)
* Editing types and their statuses in UI
* Status transition and other workflow rules
* Statuses Status
**I want to** have some useful types to organize my documents
**so that** I can communicate easier the purpose of a document
**Goals**
* Simplify naming of documents (don't repeat the type in the title)
* Make it simpler to find a document (... via filtering)
* In future versions we plan to use types to add specific
* workflows, having specific statuses
* template content
* Support for sign-off processes
* Allow other tools, e.g. magic AI agents, to create certain types.
* Document
* **Documentation (knowing that it overlaps with purpose of
* ~~Other~~ (--> General Document)
* Seed additional document
* Explanation: The latest version
* **Note**
* **Report**
* **Manual (knowing that it overlaps with purpose
* **Analysis**
* **Protocol (knowing that overlaps with purpose of Meetings module)**
* ~~**FAQ**~~ **(is better stored
* Contract
* If there is a type called "Other" (or a translation in their team's language) AND there are no documents stored on the instance having that type then remove that type.
**Types and Translations**
* Note
* General Document
* Specification
* Documentation
* Protocol
* Report
* Manual
* Analysis
**Translations**
In this order:
<figure class="table op-uc-figure_align-center op-uc-figure"><table class="op-uc-table"><thead class="op-uc-table--head"><tr class="op-uc-table--row"><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">Document Type</p></th><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">Description</p></th><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">German Translation</p></th><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">French Translation</p></th><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">Spanish Translation</p></th></tr></thead><tbody><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p
**Out of scope**
* Migrating Document categories to types (Migration need to run before seeding)
* Editing types and their statuses in UI
* Status transition and other workflow rules
* Statuses