Do you provide project documentation?

Yes — comprehensive documentation is a standard deliverable on every project. We have seen too many projects fail post-handover because the previous vendor left no documentation. We treat documentation as a first-class deliverable, produced during development rather than rushed at the end.

What We Document

Technical Documentation

• Architecture overview: System diagrams showing how frontend, backend, databases, and third-party services connect.
• API documentation: Every endpoint documented with request/response examples, authentication requirements, and error codes. We use tools like Swagger/OpenAPI for interactive API docs.
• Database schema: Entity-relationship diagrams and table descriptions for every data model.
• Code documentation: Inline comments on complex logic, README files per module, and coding conventions used in the project.

Deployment & Infrastructure

• Deployment runbook: Step-by-step instructions for deploying to staging and production environments.
• CI/CD pipeline docs: How the automated build, test, and deployment pipeline works.
• Environment configuration: All environment variables, server configurations, and cloud service settings documented securely.
• Monitoring setup: What is monitored, alert thresholds, and escalation procedures.

User-Facing Documentation

• User guides: Step-by-step instructions for end users, with screenshots and workflows.
• Admin manuals: How to manage users, content, configurations, and system settings.
• Training materials: For projects like MedicalMet (300+ clinics) and the Perodua SA app (3,000+ advisors), we create onboarding guides tailored to each user role.

Living Documentation

Documentation is updated with every major release during the maintenance phase. If you are on a support plan, documentation updates are included as part of the package.

Source Code Ownership

All documentation is delivered alongside the source code, which you own completely. If you ever transition to another team, they will have everything needed to continue development without reverse-engineering your codebase.