Documentation Directory Structure
This is the recommended directory structure for Amalanku mobile app documentation:
docs/
├── README.md # Main documentation entry point
├── introduction.md # App overview and purpose
├── getting-started/
│ ├── installation.md # How to install the app
│ ├── first-setup.md # Initial app configuration
│ └── quick-tour.md # App walkthrough
├── user-guide/
│ ├── amalan-tracking.md # How to track daily practices
│ ├── reminders.md # Setting up notifications
│ ├── analytics.md # Viewing progress reports
│ ├── dua-collection.md # Using prayer collections
│ └── settings.md # App configuration
├── features/
│ ├── prayer-times.md # Prayer time calculations
│ ├── qibla-direction.md # Compass feature
│ ├── islamic-calendar.md # Hijri calendar
│ └── community.md # Social features
├── technical/
│ ├── requirements.md # System requirements
│ ├── permissions.md # App permissions needed
│ ├── offline-mode.md # Offline functionality
│ └── data-privacy.md # Privacy and data handling
├── development/
│ ├── setup.md # Development environment
│ ├── architecture.md # App architecture
│ ├── api-reference.md # API documentation
│ └── contributing.md # Contribution guidelines
├── support/
│ ├── faq.md # Frequently asked questions
│ ├── troubleshooting.md # Common issues
│ └── contact.md # Support contacts
└── changelog.md # Version historyDirectory Descriptions
Core Documentation
- README.md - Entry point with overview and navigation
- introduction.md - Comprehensive app introduction
- changelog.md - Version history and updates
User-Focused Sections
- getting-started/ - New user onboarding materials
- user-guide/ - How-to guides for main features
- features/ - Detailed feature explanations
- support/ - Help and troubleshooting resources
Technical Documentation
- technical/ - System requirements and technical details
- development/ - Developer-focused documentation
This structure ensures easy navigation and logical organization of all documentation materials.