Process
Since processes are best described visually, the main component of their documentation is a process diagram. However, the process design itself is not sufficient. Since processes represent the core company asset, the documentation should also serve as an overview describing the purpose of the process, how it supports the business, who is responsible for the process, or which systems implement it.
Process Diagram Documentation
There are two ways to document processes in Confluence, both having advantages and disadvantages:
- The process steps and flows are described in Enterprise Architect in the Note attribute
- It is fast, the texts are available in EA and can be generated to the page by middleware
- On the other hand, the editing capabilities of the Note field are limited
- The process steps and flows are described in Confluence
- The diagram is created in EA but the elements are described in Confluence
- This way, it is possible to use all Confluence editing features. However, the descriptions are not directly visible in Enterprise Architect
Neither approach is the best, and it depends on the actual needs. The "EA approach" is faster, so it works well for prototyping and iterative discussions of the diagram with stakeholders. Describing the diagram in Confluence is more robust as it allows taking advantage of all Confluence features, so it is suitable for post-release documentation.