Giter Club home page Giter Club logo

arcudoc's Introduction

ArcUdoc - "the desktop application to rock your doc"

Workspace View Edit CreateProject Login

What is ArcUdoc?

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.

Features

  • 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

Usage

Currently only usable via IntelliJ or comparable development environment. The Main method can be found in the UI module in the root package.

Documentation

Detailed project documentation can be found here

Technologies

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.

Known Issues

  • 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

Project status / future plans

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, ...)

Authors

Pia Schilling, Vivien Volpert, Paul Sendelbach, Sara Tietze

arcudoc's People

Contributors

kawamotomatic avatar piaschilling avatar saratietze avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.