Skip to Content

Software Documentation Framework

Our documentation framework allows large software systems to be documented in a structured and surprisingly accessible format, giving your engineers a better understanding of both the overall software architecture and specific details that may not be obvious from the source code itself.

When creating software, code alone is rarely sufficient. In a perfect world, documentation would be created alongside the code as a product is developed. However, in reality time pressures and re-use of old code can result in a sprawling code base that becomes increasingly difficult to understand.

 Document existing software in an easily extensible framework

 Review current software and make recommendations

 Improve accessibility and usability of documentation

 Decrease time taken for engineers to understand unfamiliar code

 Minimise barriers to keeping documentation up-to-date

Find out more
To learn more about how we have developed this innovative solution, read our professional note here.