# User Problem

## User

Any user working with long-lived documents that involve multiple steps and/or users.

## Problem

Begin of the insertion* End of the insertion I need to create, edit, Begin of the insertionorganizeEnd of the insertion Begin of the deletion organiseEnd of the deletion and find documents that relate to my projects. Begin of the insertion

* End of the insertion Begin of the deletion
End of the deletion I need to have an intuitive and modern Begin of the insertiontextEnd of the insertion editing experience. Begin of the insertion

* End of the insertion Begin of the deletion
End of the deletion I need to collaborate with co-workers in real-time on documents. Begin of the insertion

* End of the insertion Begin of the deletion
End of the deletion I need to find and create work packages that relate to the document I'm working on directly from the document. Begin of the insertion

* End of the insertion Begin of the deletion
End of the deletion I need to have AI tools to assist me in text editing. Begin of the insertion


End of the insertion Begin of the deletion

End of the deletion ## Pain

To efficiently collaborate with colleagues in a remote environment it is often necessary to work in the same context at the same time. Without live-collaboration, only one person can edit at the same time and this forms a significant bottleneck to the flow of ideas and conversation. Without integration with project management objects via macros, it is necessary to switch context and update information manually.
Without AI tools integration it is necessary to either forsake their use or context switch to a different tool/browser tab.

# Business Case

## Reach

This is a prevalent problem especially in remote work contexts.

## Impact

On average a I assume a medium impact for users. I think it will have a large impact for users that need to work collaboratively in a remote context. For other users the impact will be fairly small.

## Confidence

Confidence is very high, we constantly see the need for this in our own work.

## Urgency and Priority

This has high priority as we're preparing to integrate with other applications that use BlockNote (such as Xwiki and Docs) through OpenProject specific BlockNote extensions.

## Solution

Adapt existing documents module, adapt the existing live-collaboration features from our hackathons. The editor will be replaced with BlockNote and Yjs/Hocuspocus will be used to get live-collaboration. Additionally we hope to integrate text transformation AI features in this version.

## Differentiation

Direct integration into the project management software, combined with a modern text editing experience.

# Roadmap

## Version 1

Begin of the deletion ##

End of the deletion #### List of documents (Index)

* Begin of the insertion<mention class="mention" data-id="66595" data-type="work_package" data-text="##66595">##66595</mention>

* End of the insertion Columns for Name, Type, and Last Edited

* Search titles

* Filtered views by Types in left hand menu

* ~~Sort by table columns~~

* _Leave this out of version 1, as Design team wants to do more work to design this in general so it can also be applied to workpackages for example._


#### Begin of the insertion~~CleanEnd of the insertion Begin of the deletion CleanEnd of the deletion View (Distraction Begin of the insertionfree)~~ &nbsp;_Moved out of version 1_.End of the insertion Begin of the deletion free)End of the deletion

* Begin of the insertion~~##67420~~

* ~~InEnd of the insertion Begin of the deletion InEnd of the deletion this view the focus is on the text being read/edited and there are very few elements apart from that main Begin of the insertioncontent~~End of the insertion Begin of the deletion contentEnd of the deletion

* Begin of the insertion~~SidebarEnd of the insertion Begin of the deletion SidebarEnd of the deletion collapsed so the content is completely centered Begin of the insertionhorizontally~~End of the insertion Begin of the deletion horizontallyEnd of the deletion

* Begin of the insertion~~DefaultEnd of the insertion Begin of the deletion DefaultEnd of the deletion for opening a (collaborative) Begin of the insertiondocument~~End of the insertion Begin of the deletion documentEnd of the deletion

* Begin of the insertion~~directly editable~~End of the insertion Begin of the deletion directly editableEnd of the deletion

* Begin of the insertion~~Only contains~~End of the insertion Begin of the deletion Only containsEnd of the deletion

* Begin of the insertion~~theEnd of the insertion Begin of the deletion theEnd of the deletion main Begin of the insertioncontent~~End of the insertion Begin of the deletion contentEnd of the deletion

* Begin of the insertion~~theEnd of the insertion Begin of the deletion theEnd of the deletion title (edit in Begin of the insertionplace)~~End of the insertion Begin of the deletion place)End of the deletion

* Begin of the insertion~~the type~~End of the insertion Begin of the deletion the typeEnd of the deletion

* Begin of the insertion~~active collaborators~~End of the insertion Begin of the deletion active collaboratorsEnd of the deletion


#### Begin of the insertionShow/Edit viewEnd of the insertion Begin of the deletion Detail ViewEnd of the deletion

* Begin of the insertion<mention class="mention" data-id="67424" data-type="work_package" data-text="##67424">##67424</mention>

* ~~detailEnd of the insertion Begin of the deletion detailEnd of the deletion view can be enabled/disabled, it adds further elements to the clean Begin of the insertionview,~~End of the insertion Begin of the deletion view,End of the deletion for now it will only contain

* Attachments

* Design to extend to other things we add later (Activity, Versions...)

* Collaboration

* Project permissions determine access control to document (no document-level Begin of the insertionpermissions,End of the insertion Begin of the deletion permissionsEnd of the deletion yet)

* **\[Simultaneous editing (via Hocuspocus and Yjs)\]**


#### Migration

* Begin of the insertion<mention class="mention" data-id="67425" data-type="work_package" data-text="##67425">##67425</mention>

End of the insertion Begin of the deletion _**TASKS:**_

End of the deletion * Turn existing categories into types, documents into collaborative documents and keep attachments Begin of the insertion


End of the insertion Begin of the deletion

* Test migration to see how well it works


End of the deletion #### Begin of the insertion~~AIEnd of the insertion Begin of the deletion AIEnd of the deletion assistance - STRETCH Begin of the insertionGOAL~~  _Not for version 1_End of the insertion Begin of the deletion GOALEnd of the deletion

* Begin of the insertion<mention class="mention" data-id="66329" data-type="work_package" data-text="##66329">##66329</mention>

* ~~**\[Summarise\]End of the insertion Begin of the deletion **\[Summarise\]End of the deletion - STRETCH GOAL Begin of the insertion#**~~End of the insertion Begin of the deletion #**End of the deletion


#### Begin of the insertion~~**BlockNote extension &quot;TextEnd of the insertion Begin of the deletion **\[TextEnd of the deletion to Begin of the insertionaction&quot;**~~End of the insertion Begin of the deletion action\]**End of the deletion

Begin of the insertion#### **BlockNote extension &quot;Link existing work package&quot;**

End of the insertion * Begin of the insertion<mention class="mention" data-id="66326" data-type="work_package" data-text="##66326">##66326</mention>

* End of the insertion Reference and Begin of the insertiondisplay work packagesEnd of the insertion Begin of the deletion visualise workpackagesEnd of the deletion (like current macros with ## but Begin of the insertionnow withEnd of the insertion Begin of the deletion alsoEnd of the deletion the new / command)

* Begin of the insertion~~alsoEnd of the insertion Begin of the deletion alsoEnd of the deletion transform links to Begin of the insertionwork packages~~ _Out of scope for version 1_


**BlockNote extension &quot;**~~**(Batch)**~~ **create work package** ~~**(from text)**~~**&quot;** _**Will probably not make it into 17.0**_

End of the insertion Begin of the deletion workpackages

End of the deletion * Begin of the insertion~~CreateEnd of the insertion Begin of the deletion **\[ (Batch) create workpackage from text\]**

* CreateEnd of the deletion a Begin of the insertionwork packageEnd of the insertion Begin of the deletion workpackageEnd of the deletion by typing /wp, then selecting the type, then entering the title and confirming with Begin of the insertionenter~~

End of the insertion Begin of the deletion enter

End of the deletion * Begin of the insertion~~IfEnd of the insertion Begin of the deletion IfEnd of the deletion this is done in a list/enumeration, the next item should also start in the Begin of the insertionwork packageEnd of the insertion Begin of the deletion workpackageEnd of the deletion creation Begin of the insertionflow~~ Batch creation needs to be implemented in later version. It will probably be independent of enumerations.

End of the insertion Begin of the deletion flow

End of the deletion * Begin of the insertion~~CreateEnd of the insertion Begin of the deletion CreateEnd of the deletion a Begin of the insertionwork packageEnd of the insertion Begin of the deletion workpackageEnd of the deletion list by typing /wp-list (eg. like in the Paris Hackathon &#39;list Begin of the insertionmode&#39;)~~ There wont be a separate &quot;reate list&quot; mode.

End of the insertion Begin of the deletion mode&amp;#39;)

End of the deletion * Begin of the insertion~~SelectEnd of the insertion Begin of the deletion SelectEnd of the deletion a list and create a Begin of the insertionwork packagesEnd of the insertion Begin of the deletion workpackagesEnd of the deletion from each item in the list, replace item with work package Begin of the insertionreference~~ Not part of version 1

End of the insertion Begin of the deletion reference

End of the deletion * Begin of the insertion~~ReferenceEnd of the insertion Begin of the deletion ReferenceEnd of the deletion documents from work packages (eg. with the # approach in CKEditor or the / command in Begin of the insertionBlockNote)~~ Not part of version 1End of the insertion Begin of the deletion BlockNote)End of the deletion

* Begin of the insertion_~~Note:End of the insertion Begin of the deletion _Note:End of the deletion Allowing users to choose the type of Begin of the insertionwork package,End of the insertion Begin of the deletion workpackage,End of the deletion brings additional challenges because the type may not be valid without certain fields, the subject may be automatically generated. In addition it will not be as smooth to display the status as it is the case of task which has a boolean status (checked / Begin of the insertionunchecked)~~ Version 1 has no status attribute and also not other custom fields._End of the insertion Begin of the deletion unchecked)_End of the deletion

* Begin of the insertion_~~Note:~~_ _~~MaybeEnd of the insertion Begin of the deletion _Note:_ _MaybeEnd of the deletion the /keyword needs to be configurable? This extension could be used outside of OpenProject (OpenDesk, elsewhere) to invoke the OP-specific Begin of the insertiondropdown.~~_End of the insertion Begin of the deletion dropdown._End of the deletion


#### API

* We have an API and need to make sure we don&#39;t break it. The strategy to achieve this will depend on the migration decision

* _Note: The existing API only provides GET for documents, simplifying this significantly._

* How can this work with YJS documents for creates and Begin of the insertionupdates?End of the insertion Begin of the deletion updatesEnd of the deletion

* _**TASK: we need to research/prototype how we can do this.**_


#### Rename Categories to Types

* _Note: because we&#39;re not introducing Status yet, on the surface this is just a rename - even if we create a larger change and migration underneath._

* As long as we have not migrated the existing documents, it will be necessary to Begin of the insertion~~useEnd of the insertion Begin of the deletion useEnd of the deletion the Begin of the insertiontype~~ a DB attributeEnd of the insertion Begin of the deletion typeEnd of the deletion to differentiate between a collaborative Begin of the insertionBlockNoteEnd of the insertion Begin of the deletion blocknoteEnd of the deletion document and the old Begin of the insertionCKEditor5End of the insertion documents

* Begin of the deletion ALTERNATIVELY the differentiation could be based on an attribute on the document itself - may make migration easier as well.

* End of the deletion _**NOTE: There is a way to configure Categories, we&#39;ll need to adapt it to Types.**_


Begin of the deletion &lt;br&gt;

##### _Additional Notes_

_**\[Description\]** denotes a feature that will make people care. The other features are basics that are needed but do not inspire._

_Collaboration is supposed to be the main focus, but we need to carefully decide which features to include to get a great result without taking a very long time to achieve it_

End of the deletion ##

## Further versions

### Collaboration

<mention class="mention" data-id="67551" data-type="work_package" data-text="###67551">###67551</mention>

### AI assistance (WIP)

* **\[Text to Task\]**

* Mark some text and let AI create a suitable task (bug, feature) with a good description.

* **\[Summarise\]**

* **\[Transform text according to user instructions\]**

* **\[Translate\]**


### Integrations

<mention class="mention" data-id="67429" data-type="work_package" data-text="###67429">###67429</mention>

and

<mention class="mention" data-id="67526" data-type="work_package" data-text="###67526">###67526</mention>

### Workflows (WIP)

<mention class="mention" data-id="67590" data-type="work_package" data-text="###67590">###67590</mention>

### **File based documents (WIP)**

<br>

### **Other (WIP)**

* **\[Outline\]**

* Quick filters for Index

* Notes


# Launch and Growth

## Measures

_?_

## Messaging

Edit documents collaboratively in OpenProject.

From text to action

<figure class="table op-uc-figure_align-center op-uc-figure"><table class="op-uc-table"><tbody><tr class="op-uc-table--row"><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">Headline</p></th><td class="op-uc-table--cell"><p class="op-uc-p"><strong>Turn ideas into action — together.</strong></p></td></tr><tr class="op-uc-table--row"><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">First Paragraph</p></th><td class="op-uc-table--cell"><p class="op-uc-p">OpenProject 17 introduces real-time collaboration for text documents.</p><p class="op-uc-p">Every great project starts with an idea — but capturing and structuring those ideas together has always been tricky. Notes get scattered, access is limited, and context is lost.</p><p class="op-uc-p">With the new Documents module, teams can now co-write, plan, and refine ideas directly in OpenProject. Reference milestones, link work packages, and move seamlessly from text draft to actionable project plan — all in one place.</p></td></tr><tr class="op-uc-table--row"><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">Customer Quote</p></th><td class="op-uc-table--cell"><p class="op-uc-p"><br data-cke-filler="true"></p></td></tr></tbody></table></figure>

## Go to market

?

_How are you planning on getting this into users&#39; hands?_