ArcUDoc is intended to make it easier to create structured software architecture documentation based on the arc42 architecture documentation template. Especially new team members should find it easier to familiarize themselves with a new project. Also the cooperation between developers and architects should be simplified. Guidelines, concepts and generally applicable procedures in the team are recorded there and easily accessible for all team members.
- Create projects and invite team members
- See project invitations and accept them to be part of the project
- View and edit the contents of the project documentation using an integrated Markdown editor
Currently only usable via IntelliJ or comparable development environment. The Main method can be found in the UI module in the root package.
Detailed project documentation can be found here
More detailed explanations of the technologies used in this project can be found here. See "Design Decisions" for a more detailed explanation of why we chose these technologies.
- Login was only tested extensively in Firefox. Login via other browsers could cause problems (especially in Safari). (see AuthFlow for furhter details)
- Login via Google not yet implemented
- Missing implementation of Searchbar and Join-Project-Button in Workspace-Screen, Team and Design Buttons in Project-Screen
The following features are planned to be implemented in the future:
- version control or at least the possbibility to view past versions of the documentation
- offline usage
- implementation of the "design" and "team" part in the project screen. In the design part it will be possible to record design guidelines etc. for the project. In the team part it will be possible to see all members of the projects with theier project roles, job labels and further information.
- Access control based on the defined project roles (edit, view, ...)
Pia Schilling, Vivien Volpert, Paul Sendelbach, Sara Tietze