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.