How we automated writing docs with an Ona Automation
Blog post from Ona
Benjamin Stark describes the development and implementation of an Ona Automation that addresses the common issue of outdated documentation in engineering organizations by scanning the codebase daily, detecting changes affecting user-facing behavior, and automatically drafting a pull request with updated documentation. This automation contrasts with existing tools like Mintlify, which only flag outdated documentation, by providing a proactive solution that creates draft updates in the company's established tone and style, thus reducing the time engineers spend on manual documentation updates. The system operates in a secure environment, utilizes the same Dev Container setup as the engineering team, and has been fine-tuned to batch changes daily while ignoring irrelevant internal modifications. As a result, the organization experiences improved documentation quality and consistency, reducing the burden on engineers and enhancing customer trust. The automation runs seamlessly in the background, offering a scalable pattern for teams where documentation and code repositories tend to drift apart over time.