Combining 5 Tools in one Solution:
Dev-Doc is a comprehensive and complete solution that covers all the documentation components of a software project. Leveraging the latest technologies, it meets the needs of both developers and stakeholders alike. Dev-Doc is developed to provide a standardized solution for medium and large software projects.
Let’s Make Documentation:
Main Features:
One Solution for all Documenta-tion
One Place for all Documenta-tion
Ready to Go in 5 Min
Storage location: your GIT Repository
Tech-Stack: AsciiDoc
Editable in both IDE and Online
Fully Automated Code Doku with AI
Auto updates on each Release
Fully auto generate Visual Software Architecture
Tips and recomm-endations from Experts
Guided & Clear processes
Documenta-tion that helps
Create individual Workflows
Add Status to each Documenta-tion Step
Reporting Dashboard
Canvas for Stakeholder
Canvas Doku
The canvas contains basic information about the software project and is an important source of information for the stakeholders. The canvas shows the most important information of the projects in a particularly clear way.
ℹ️ No deep technical details are described in the canvas, but the basic basics and background information.
We have implemented the following canvas according to the ARC42 standard: Inception Canvas & Communication Canvas
Main Docu / Wikipedia
The wiki contains all the deep technical details about the software project so that the documentation becomes a useful resource for the development team. ✅ The wiki should include the following topics: method documentation, description of the source code, descriptions of the data structures used, documentation of the APIs, versions, goals, requirements, concepts, description of test cases and test procedures.
Detailed Docu for DEV Team
helpful AI generated Code Docu
Source Code Doku
Our “Code Doku” contains two areas:
1️⃣In the first area, you can link all readme files from your Git repository so that all information from the readme can be found quickly.
2️⃣In the second area, you can automatically generate AI-generated documentation of your source code. This saves you work when writing source code comments. Our AI creates: a) the meanings and workings of individual methods, b) information such as how the methods communicate with each other, c) a short summary of the source code file as a whole.
The code documentation is particularly helpful for new project members to find their way around more quickly and to reduce recurring queries to the senior developer.
Visual Architecture
The visual architecture documentation is the centerpiece of dev-doc. 💖 Using an innovative analysis of all methods, we create a visual architecture of your software exactly as it really works and operates. No more manually creating PowerPoints or extra code to create diagrams. The visual architecture makes it possible to understand how the software works in just a few seconds.
Architecture for complex Projects
Instructions for end users with auto-publish in web
End User Documentation
You may need instructions for the end users of your software that describe how to use your software. With the help of Asciidoc, documentation is created easily and simply and converted into HTML with Antora. This means that the user instructions can be automatically published as a website with just a few steps.
Guided Process
We have developed the latest best practices for software documentation and added a guided, voluntary mode. This mode guides you through the various areas of documentation in simple and quick steps.
When you use this mode, you will be asked a few questions about your project and then given recommendations on which documentation blocks are useful for your project. You can also activate workflows to ensure that the documentation is not forgotten when the next release is made.
Thanks to Canva and visual architecture, documentation is generated very quickly and easily, is easy to update and is really helpful.
Access Management
In dev-doc, each team user can be assigned individual access rights for each project: editor, viewer, no access. Administrators can invite users, create projects, and create groups for access roles.
Security
Dev-doc is hosted on our own server in Germany in the Basic and Premium plans. All your documentation is stored in your own Git repositories. You can optionally activate fast caching, which synchronizes the data from the Git repository with our fast database.
In Enterprise plan, companies can host dev-doc on their own server and enjoy all the performance advantages and maximum security.
By using dev-doc, you solve the following problems:
- No longer loss of knowledge in your project & team.
- Consistent documentation that satisfies your team and stakeholders.
- Skip the lengthy onboardings for new team members.
- Achieve a high level of acceptance in your DEV team.
- Create only the docu you really need.
- Reduce effort and time to create documentation.
