Content
View differences
Updated by Wieland Lindenthal 8 months ago
**As** a user
**I want to** have some useful types for creating a directly edited, collaborative document
**so that** I can 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
* template content
<br>
**Acceptance criteria**
* Seed document types (same as seeded for categories)
* **Documentation (knowing that it overlaps with purpose of the Wiki module)**
* **Specification**
* ~~Other~~ (--> General Document)
* Seed additional document types
* Basic document/Simple document//None/General/Unspecific/Random/No type
* **Note**
* **Report**
* **Manual (knowing that it overlaps with purpose of the Wiki module)**
* **Analysis**
* **Protocol (knowing that overlaps with purpose of Meetings module)**
* ~~**FAQ**~~ **(is better stored in a Wiki)**
* Contract
* Alphabetical order of types
* Note
* General Document
* Specification
* Documentation
* Protocol
* Report
* Manual
* Analysis
**Translations**
<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 | Document Type | Description | German Translation | French Translation | Spanish Translation |
|---------------------|------------------------------------------------------------------|----------------------------|--------------------------|--------------------------|
| General Document | 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">Informal categories. | Allgemeines Dokument | Document général | Documento general |
| Note | 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">Report</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Summarizes drafts. | Notiz | Note | Nota |
| Report | 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 findings. | Bericht | Rapport | Informe |
| Plan | Outlines steps, timelines, or responsibilities.</p></td><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">Plan</p></td><td class="op-uc-table--cell"><p 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 responsibilities. | Plan | Plan | Plan |
| Specification | 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 behavior. | Spezifikation | Spécification | Especificación |
| Documentation | 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 elsewhere.| Dokumentation | Documentation | Documentación |
| Protocol | 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 outcomes. | Protokoll | 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 Protocole| Protocolo |
| Analysis | 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 options. | Analyse | Analyse | Análisis |
| Proposal | 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">Guideline</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Defines approval. | Antrag | Proposition | Propuesta |
| Guideline | Defines rules, standards, or best practices.</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Richtlinie</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Directive</p></td><td class="op-uc-table--cell"><p 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">Manual</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Offers practices. | Richtlinie | Directive | Directriz |
| Manual | Offers instructions for usage, setup, or maintenance.</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Anleitung</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Manuel</p></td><td class="op-uc-table--cell"><p 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">Template</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Provides maintenance. | Anleitung | Manuel | Instrucciones |
| Template | Provides a reusable structure for repeated tasks or documents.</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Vorlage</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Modèle</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Plantilla</p></td></tr></tbody></table></figure>
documents. | Vorlage | Modèle | Plantilla |
**Out of scope**
* Editing types and their statuses in UI
* Status transition and other workflow rules
* Status
**I want to** have some useful types for creating a directly edited, collaborative document
**so that** I can 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
* template content
<br>
**Acceptance criteria**
* Seed document types (same as seeded for categories)
* **Documentation (knowing that it overlaps with purpose of the Wiki module)**
* **Specification**
* ~~Other~~ (--> General Document)
* Seed additional document types
* Basic document/Simple document//None/General/Unspecific/Random/No type
* **Note**
* **Report**
* **Manual (knowing that it overlaps with purpose of the Wiki module)**
* **Analysis**
* **Protocol (knowing that overlaps with purpose of Meetings module)**
* ~~**FAQ**~~ **(is better stored in a Wiki)**
* Contract
* Alphabetical order of types
* Note
* General Document
* Specification
* Documentation
* Protocol
* Report
* Manual
* Analysis
**Translations**
<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
|---------------------|------------------------------------------------------------------|----------------------------|--------------------------|--------------------------|
| General Document | Default
| Note | Informal
| Report | Summarizes
| Plan | Outlines
| Specification | Defines
| Documentation | General
| Protocol | Describes
| Analysis | Provides
| Proposal | Suggests
| Guideline | Defines
| Manual | Offers
| Template | Provides
* Editing types and their statuses in UI
* Status transition and other workflow rules
* Status