Software Documentation Case Study

Building complex software applications using familiar languages with unfamiliar APIs, specialist nuances and unconventional architectures presents an interesting challenge for any RAG solution. The LLM has not been trained on it, and the common programming/scripting language components are not all used in a standard way or using the latest version — among the challenges to gaining accurate responses.

Using a software application that we have extensive experience of, and which aligns with these complexities, made for a superb testbed when configuring the iA Help portal for Arbortext Layout Developer (formerly APP/3B2). Using the extensive configuration options of our iA toolset, we've navigated these challenges from all sides of the solution — from input data forms to complex prompt engineering — to bring this project to fruition.

This free developer community project, hosted by Univoco, brings together many years of knowledge from many different sources into a unique resource for developers and users of this application, enabling fast access to thousands of documented resources globally and in any language. Enabling users to rate and give feedback on the output, and contributors to help build the archive, maintains a large pool of information that makes it easier for new and existing users alike.