Is there any standard for documentation of the architecture of an android application?

Asked

Viewed 49 times

0

I am developing an application and only now, at the end of the development, a person was assigned to help me and asked me to do a detail of the architecture to facilitate the understanding of this person.

I’m a little lost on what I should put on... Can anyone tell me if there’s a model I can follow to do this? Or what information you should put?

Grateful

  • There are such models: MVC, MVP, MVVM...

  • An explanation for them is available here: https://android.jlelse.eu/android-architecture-2f12e1c7d4db

  • And an example of them here: https://github.com/googlesamples/android-architecture

  • Great links @Luc

1 answer

1

To document the architecture of any software project, the ideal is to use the UML, because it is a language well known and that provides all the elements to represent elements of software. To perform the modeling you can use the tool Draw io..

On what to put in the document, the ideal is for you to have, at least, models that help the person to:

  • View the entities of the domain for which the application was created and their relationships.

    • For this you can create a Conceptual Model of Business.
  • View the components(or Packages) of your application and its dependencies.

    • In a well-defined architecture application, each component provides domain-specific functionality and handles specific entities, for example: login component, network component, session component etc..

Browser other questions tagged

You are not signed in. Login or sign up in order to post.