Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How do we create android application custom documentation for application flow?

Recently my team mates has started to work on an android application, which has more than 200 screens in an application.

In this case, I face one issue that when I need to explain the code or flow of screen to the other developer it would too much difficult. So I have to google to find the solution.

I am not much aware of the solution for android. In javascript, I have used jsDoc or swagger for API documentation, which offered a great way.

But in android, I unable to find the solution for coding documentation and screen flow.

Do I need any design tool to explain screen flow and documentation of an android application?

Let me know if you need more details or explanation I shall update the question accordingly or improve my question.

like image 238
Dipak Avatar asked May 11 '26 21:05

Dipak


1 Answers

There is no way to create an automated screen / state transition diagram. If you use the Navigation Architecture component, you can use the navigation editor which is similar to Apple's storyboards. This is helpful but often times doesn't cover everything.

Android Studio navigation editor. Source: https://developer.android.com/guide/navigation/navigation-getting-started#nav-editor

In our projects we rely on tools like overflow.io to create and maintain the screen flow diagrams. We use either design files from sketch or Adobe XD or screenshots from our app. This is a very manual process.

like image 64
Alexander Hoffmann Avatar answered May 13 '26 12:05

Alexander Hoffmann