Ask for documentation when outsourcing your project

When outsourcing your project to an agency or freelancer, the primary focus is often on delivering the application on time. However, one aspect is almost always overlooked: documentation. In many cases, no documentation is provided at all. This creates a risky dependency on the third party, which could become a bottleneck for your project’s future. To avoid this, it’s vital to start planning for continuity right from the start.

So, what should be the minimum documentation to expect? An architectural overview provides a high-level view of the application's structure, explaining how the various components interact and detailing the technologies in use. A README, located close to the code, should include clear instructions on how to set up the application locally, along with steps for deployment and an explanation of the external services being used. These documents are the foundation for enabling other developers to understand and maintain your application quickly and effectively.

Going further, including Architecture Decision Records (ADRs) can provide valuable insights into why certain decisions were made. Detailed documentation for each component can also strengthen the continuity of your application.

Good documentation should not be an afterthought; consider it an investment in your project's sustainability and resilience.