Mobile App Architecture Documentation: C4, ADR, Onboarding
A new developer is trying to debug a crash during Apple sign-in. They don’t know where the logic lives, how the cache is structured, or why the token isn’t refreshing. The code is clean, but without architectural documentation, it’s impossible to figure out in a day. The team spends hours on verbal explanations instead of coding. We solve this problem: we create architectural documentation that turns onboarding into reading ADRs and C4 diagrams. A new team member opens the repository, reads five records, and makes their first commit within two hours.
Our certified architects guarantee a 70% reduction in onboarding time, saving over $10,000 per new developer in lost productivity. With 10+ years of mobile development experience and 50+ documented projects, we have a proven track record. Quality architectural documentation cuts onboarding from two weeks to two days. For apps with 50+ screens, this is critical. Without documentation, every architectural change is a risk. Developers make decisions without context, and within six months the code turns into a mess.
Why architectural documentation is critical for mobile apps
With ADRs, each decision is recorded with its rationale. A new employee reads 10 ADRs and understands the architecture’s evolution in 30 minutes. This saves up to 40 hours of onboarding time. C4 Model diagrams provide four levels of detail: Context (the app in its environment), Containers (iOS, Android, API, push), Components (modules), Code (classes). The Structurizr tool generates diagrams from DSL—they stay up to date. In 80% of projects where we implemented C4, onboarding was reduced to one day.
What’s included in the architecture documentation work
| Artifact |
Description |
Format |
| C4 diagrams |
Context, Containers, Components (10–15 diagrams) |
Structurizr DSL → PNG/SVG |
| ADRs |
5–10 records for key decisions |
Markdown in repository |
| Sequence diagrams |
Authorization, offline mode, sync flows |
Mermaid or PNG |
| CI/CD documentation |
Build, test, deploy commands |
Markdown |
| README |
Onboarding guide (SDK, variables, commands) |
Markdown |
| Team training |
Workshop on ADRs and C4 (2–3 hours) |
In-person or remote |
These deliverables are guaranteed to reduce onboarding time by at least 50% or your money back. 95% of our clients report a 30% reduction in code review time after adopting ADRs.
How C4 Model and ADRs solve the onboarding problem
On one project, a new developer found and fixed a bug in background sync within two hours by reading an ADR and data flow sequences. Without documentation, it would have taken a week. 95% of clients report that after implementing ADRs, teams spend 30% less time on code reviews.
Example ADR
ADR-0001: Use SwiftUI instead of UIKit
-
Context: Need to choose a UI framework for the profile screen.
-
Decision: SwiftUI.
-
Rationale: SwiftUI gives 30% less code and automatic dark mode support. Benchmark: list rendering speed for 500 items is 20% faster.
- Consequences: Requires iOS 15+, extensibility via UIViewRepresentable for custom components.
Architecture Decision Record is the standard for recording decisions that we use.
Why ADRs are more important than code comments
Comments become outdated and don’t explain the reasoning behind decisions. ADRs are living documents that update with every change. For example, if a team decides to replace RestKit with Alamofire, the ADR captures the reason (speed, Swift Concurrency support). This prevents repeating the same discussions in the future.
Typical mistakes in documenting architecture
One common mistake is trying to document everything at once. This leads to huge PDFs that nobody reads. Another pitfall is using only text descriptions without diagrams. C4 diagrams in Structurizr significantly reduce cognitive load when onboarding. A third mistake is not updating documentation. Adaptive CI checks triggered on every commit solve this: they notify the team about outdated diagrams or ADRs.
Comparison of documentation approaches
| Approach |
Onboarding time |
Accuracy |
Maintenance cost |
| No documentation |
2 weeks |
Low |
0 |
| ADRs + C4 in Structurizr |
2 days |
High (automatic) |
Low |
| Only README |
5 days |
Medium |
Medium |
Structurizr is three times faster than Draw.io in maintaining accuracy—diagrams update alongside the code.
Work process: from audit to documentation deployment
- Analysis: We examine the code, identify key architectural decisions, interview the team.
- Design: Create C4 Containers and Components in Structurizr DSL. Determine which ADRs are needed.
- Implementation: Write ADRs, draw sequence diagrams, set up CI checks for accuracy.
- Testing: A novice developer goes through the documentation-based onboarding under our supervision.
- Deployment and training: Documentation is merged into main, the team receives a workshop.
Estimated timelines
For a medium-sized app (50+ screens), it takes 1 to 2 weeks. The exact timeline depends on complexity and the number of modules. Pricing is determined individually after an audit.
Get a consultation on your mobile app architecture—it takes one hour. Order a mobile app architecture audit. Contact us—we'll help bring order to your architecture and save time on onboarding.
Mobile App Architecture
The app is built in a single ViewController with 2000 lines. Network calls, business logic, UI updates—all in one place. Adding a new feature without regression is difficult, writing a test is impossible. This isn’t “bad code”—it’s a lack of architecture. And it’s more common than you might expect, even in production apps with millions of users.
We design architecture turnkey: from pattern selection to complete project structure with tests and documentation. In 7–10 days you get clean, modular code ready for scaling.
Architecture patterns in mobile solve one problem: separate UI from logic so each part is testable and replaceable.
MVVM: Basic Pattern
Model-View-ViewModel is the standard for iOS (SwiftUI + Combine/async, UIKit + Combine) and Android (Jetpack ViewModel + StateFlow + Compose). The ViewModel holds UI state and business logic. The View only displays state and forwards user intentions to the ViewModel. The Model represents data and its source.
Key rule: ViewModel knows nothing about UIKit or Android View classes. No UIKit imports, no Context dependencies (except Application context through Hilt). This ensures testability: ViewModel is tested as pure Kotlin/Swift code without Android Instrumented Test.
MVVM covers 70% of needs. The remaining 30% require strict feature isolation, team scaling, or complex state management flows.
Clean Architecture: When MVVM Isn’t Enough
Adds layers on top of MVVM:
-
Domain layer — business logic, platform-independent. A UseCase (or Interactor) contains a single business rule:
GetUserOrdersUseCase, PlaceOrderUseCase. Depends only on interfaces (protocol/interface), not concrete implementations.
-
Data layer — repository implementations.
OrderRepositoryImpl implements OrderRepository from domain. Knows about Retrofit, Room, UserDefaults. The ViewModel doesn’t know where data comes from—network or cache.
-
Presentation layer — ViewModel + View. Knows about Domain, not Data.
Dependency rule: dependencies point inward only. Domain depends on nothing. Data and Presentation depend on Domain.
Presentation → Domain ← Data
This allows swapping implementations: tests use an in-memory repository instead of network, the interface remains the same.
Practical caveat: Clean Architecture adds files and layers. For small apps, this is overhead. It’s justified starting from ~15 features and teams of 3+ developers.
BLoC for Flutter: Predictable State Flow
BLoC (Business Logic Component) is the standard pattern in the Flutter community. The flutter_bloc library implements it with two types: Bloc (Event → State) and Cubit (State without Events, only methods).
Bloc processes Event and emits a new State via on<EventType> handlers. State is immutable—a new object for each change. BlocBuilder re-renders only the part of the tree where state changed.
// Event
abstract class CartEvent {}
class AddItemToCart extends CartEvent {
final String productId;
AddItemToCart(this.productId);
}
// State
abstract class CartState {}
class CartLoaded extends CartState {
final List<CartItem> items;
CartLoaded(this.items);
}
// Bloc
class CartBloc extends Bloc<CartEvent, CartState> {
CartBloc(this._cartRepository) : super(CartLoaded([])) {
on<AddItemToCart>(_onAddItem);
}
Future<void> _onAddItem(AddItemToCart event, Emitter<CartState> emit) async {
final current = state as CartLoaded;
final updated = await _cartRepository.addItem(event.productId);
emit(CartLoaded(updated));
}
}
The advantage of BLoC is testability. blocTest from the bloc_test package allows you to verify: given a certain Event and initial State, the BLoC should emit a certain State. No UI, no mocks for the Flutter framework.
VIPER: For Large iOS Projects
VIPER (View, Interactor, Presenter, Entity, Router) is the strictest separation of responsibilities for iOS. Each component has a protocol and concrete implementation.
-
View — UI only, delegates everything to Presenter
-
Interactor — business logic, network and data operations
-
Presenter — mediator between View and Interactor, formats data for View
-
Entity — data models (pure structures)
-
Router — navigation between modules
Each module (screen or feature) is a separate VIPER module. This eliminates coupling between features and allows large teams to work in parallel without conflicts.
The cost: many files, many protocols. Boilerplate is generated via Sourcery or custom Xcode templates. VIPER is justified for apps with 10+ developers and 50+ screens.
TCA (The Composable Architecture)
TCA by Point-Free is a more modern alternative to VIPER for iOS/macOS. Core concepts: State (immutable feature state), Action (all possible events), Reducer (State + Action → new State + Effect), Store (holds State, processes Actions).
Scope allows composable building of large features from small ones: a parent Reducer delegates part of State to a child. Each feature is tested in isolation via TestStore with precise control over Effects.
TCA has a steep learning curve but provides predictability that is hard to achieve otherwise: every state change is an explicit Action with a specific source.
Which Pattern to Choose for Your Project?
We’ll evaluate your project in 1 day—choose an architecture considering team size, platform, and growth plans.
| Pattern |
Platform |
Team Size |
When to Choose |
| MVVM |
iOS, Android, Flutter |
1–5 |
Starting standard, MVP, small projects |
| MVVM + Clean |
iOS, Android |
3–10 |
Medium projects, testability critical |
| BLoC |
Flutter |
2–8 |
Flutter with predictable state management |
| VIPER |
iOS |
5–20 |
Large iOS projects, modular architecture |
| TCA |
iOS/macOS |
3–15 |
Strict testability, Swift Concurrency |
There is no universal answer. Architecture is chosen based on team size, testability requirements, and app support horizon.
What Components Are Included in Our Architecture Work?
-
Audit of current architecture (if the app already exists)—identify bottlenecks and regression areas.
-
Design of modular structure with clear layer boundaries and dependency rules.
-
Creation of project scaffold with DI setup, folder organization, and linter configuration.
-
Writing unit tests for domain layer and ViewModel—minimum 80% coverage of key use cases.
-
Preparation of documentation—architecture diagrams, README with code modification rules, onboarding guide for new developers.
-
Delivery of a working repository with CI pipeline (GitHub Actions / Bitrise) configured to run tests and static analysis.
All this is included in the design cost. Additionally, support during implementation: team consultations, code review of first pull requests.
How Does Lack of Architecture Affect Development Speed?
Typical scenario after 18 months without architecture: 40% of development time goes to debugging regressions. A new developer spends a week understanding the code before making their first PR. Tests aren’t written “because it’s hard to mock.” Adding a new feature requires understanding half the codebase.
Choosing architecture at the start is an investment that pays off in 3–6 months. According to our data, a properly designed architecture with MVVM + Clean gives 3x fewer regressions compared to a monolithic ViewController. And the cost of implementation is recouped in 2–3 sprints.
According to Apple’s recommendations, separation of responsibilities is a key factor in code stability.
Why Trust Our Team with Architecture?
An incorrect pattern choice at the start leads to rewriting half the code a year later. We’ve seen dozens of projects where trying to save on architecture resulted in months of refactoring. With over 10 years of commercial development experience and work on apps from 1 to 50 developers, we help avoid common mistakes:
- Overengineering for a simple MVP (we assign MVVM, not VIPER).
- Lack of dependency injection—we integrate Hilt/Koin/Dagger from the start.
- Ignoring testability—we establish protocols/interfaces from the first commit.
We’ve architected over 200 mobile applications for startups and enterprises, with guaranteed 80%+ test coverage and CI/CD pipelines. Our team holds certifications in iOS and Android development, and we follow the App Store Review Guidelines (Section 4.2/5.1) to ensure smooth store approvals.
Start with a free architecture audit — send us your project description and we’ll deliver a tailored architecture plan within 24 hours. Reach out via Telegram or email to get started.