Technical Documentation

This includes documenting the software architecture (e.g., UML diagram, module diagram), important technical decisions, APIs, installation steps, and possibly a developer manual (how to set up the project). Also included is writing documentation within the code itself (clear comments for complex functions, README files).

Such documentation ensures that the knowledge within the team is explicitly recorded and not just kept in the developers' heads. This is essential for continuity: new team members can get up to speed faster, and technical problems can be identified and resolved more quickly.

Starting Points

• How to Write Technical Documentation That People Will Actually Read and Use

Key Points

• You have created a clear README or wiki with instructions for building/running the project, including dependencies (Unity version, libraries) and setup steps.
• Important technical choices or architecture are documented.
• The code is provided with adequate comments and/or docstrings, especially on more complex parts. Functions and classes have descriptions of their purpose and use. There is also consistency in code style and documentation according to any agreed standards.