How every developer at Sirus can pick up a project and start coding RIGHT AWAY

Sirus built an application that any colleague must be able to pick up, each time for a short period. With Smart Documentation, the team gets documentation per user flow automatically, straight from the code.

In SHORT

Sirus, an IT and software company from Merelbeke, Belgium, uses Smart Documentation by Smartdoxx to document its internal app Sirus Pulse per user flow. A developer who joins the project for a short period finds in one place what a flow does and which code, data and rules are behind it, and can start coding right away.

SIRUS
Customer
Sirus, IT and software company from Merelbeke, Belgium
Application
Sirus Pulse, an internal app that encourages employees to exercise
Tech stack
.NET backend, Angular frontend, Azure Functions
Challenge
Any colleague must be able to pick up the project briefly, with minimal onboarding
Solution
Smart Documentation: automatic, structured documentation per user flow
Result
Productive right away, with documentation that stays in line with the code
“Efficiency in both onboarding time and execution was key for this project.”
Thomas DevrieseData engineer, Sirus

About SIRUS

Sirus is an IT and software company from Merelbeke, Belgium. The team builds software, data platforms and IoT solutions, with a strong focus on Microsoft technology and smart city projects.

Besides its work for clients, Sirus built an application of its own: Sirus Pulse. The app encourages employees to exercise, with a competition in which colleagues take over areas based on their sports activities. The backend runs on .NET, the frontend on Angular, and part of the logic lives in Azure Functions. The code of those Azure Functions is connected as well, so Smartdoxx includes them in the documentation.

Visit the Sirus website →

The challenge: join briefly, contribute IMMEDIATELY

The project has to be picked up later by any colleague, each time for a short period. Whoever joins has to contribute right away. That is why Sirus set two requirements:

  • Minimal onboarding time: whoever works on the project only briefly cannot afford a long ramp-up
  • Minimal time next to coding: no hours spent searching the code, asking colleagues or updating documentation

Hand-written documentation does not solve that: it falls behind the code and takes time to maintain.

The solution: documentation per USER FLOW

Smartdoxx reads the application's code and automatically writes structured documentation for it. When the code changes, the documentation follows.

Smartdoxx finds the flows in the application by itself, in the user interface as well as in the APIs, and groups them per domain. The team chooses which flows go into the documentation. New flows can be included automatically as soon as Smartdoxx finds them in the code.

FlowsDetect

Select which detected flows should be included in each documentation.

Auto-include newly detected flowsNew flows found in your codebase are included automatically
UIAPIAutomated

ACHIEVEMENT MANAGEMENT (2)

View earned badges UISee which badges you earned with your sports activities
Included
Earn a badge UIA badge is awarded when an activity meets its rules
Included

The difference is in the structure. Smartdoxx does not organise the documentation per file or folder, but per user flow: a path a user takes through the application, such as viewing the badges they earned. For each flow, a developer finds:

  • What the flow does, in plain language
  • Which code belongs to it
  • Which data and rules in the code apply to that flow
The app’s codeThe single source
SmartdoxxReads the code and writes the docs
Documentation per flowWhat the flow doesWhich code belongs to itData and rules
DeveloperWorks on one flow at a time

Changes the code, the documentation follows automatically

That matches how work comes in. A developer rarely gets the request “change file X”, but rather “change something in flow Y”. With Smartdoxx, they start in the right place.

Every change to the code automatically ends up in the documentation of the flow it affects.

The result: productive RIGHT AWAY

Whoever joins the project at Sirus works independently on a flow right away, and spends their time coding, not searching or asking for explanations.

WITHOUT SMARTDOXX WITH SMARTDOXX
Getting started Reading through the code or asking a colleague Opening the flow and reading what it does
Knowing what a change affects Working it out in the code Code, data and rules per flow in one place
Keeping documentation up to date Manual work that falls behind the code Automatic, always in line with the code
Who can work on the project Whoever already knows it Any colleague
“It automatically detects everything that is possible in the application, in no time.”
Thomas DevrieseData engineer, Sirus

Questions about this STORY

Does Smartdoxx work with .NET, Angular and Azure Functions?

Yes. At Sirus, Smartdoxx documents an application with a .NET backend, an Angular frontend and logic in Azure Functions. The Azure Functions code is connected too, so those flows are part of the documentation. Smartdoxx reads code directly and is not tied to one language or framework.

What is documentation per user flow?

Instead of organising documentation per file or folder, Smartdoxx organises it per user flow: a path a user takes through the application, such as viewing the badges they earned. For each flow it describes what the flow does in plain language, which code belongs to it, and which data and rules apply.

How does the documentation stay up to date?

Smartdoxx reads the code again when it changes, and every change ends up in the documentation of the flow it affects. New flows can be included automatically as soon as they are found, or wait for the team to choose.

Should colleagues pick up your project just as fast?

Smartdoxx automatically creates documentation per user flow, straight from your code, and keeps it up to date while you build. Curious which flows it finds in your codebase?