How We Taught an AI to Nitpick Docs
Blog post from Apollo
Over the past few years, Daniel Abdelsamed at Apollo has developed an "AI Librarian" suite of tools, with the AI Style Guide Review being a standout. This tool assists in enforcing documentation style guides by integrating with GitHub and deploying AI to review documentation changes. Initially, the tool faced challenges such as generating false positives and vague feedback, prompting a restructure of the style guide to better suit AI pattern recognition through explicit do-don't examples. The AI was integrated into Apollo's workflow, utilizing GitHub status checks for real-time feedback and a custom dashboard for detailed analysis. To handle large-scale changes efficiently, the process was optimized through parallel execution, caching, and line-level granularity, significantly reducing both execution time and cost. This project emphasized that structuring prompts for AI can be more critical than the complexity of the AI model itself, and effective integration requires attention to non-AI aspects such as workflow integration and dashboard creation.
| Trend | Post Mentions | Total Month Mentions | Posts | Companies | MoM |
|---|---|---|---|---|---|
| Observability | 2 | 3,204 | 716 | 172 | +14% |
| Real-time | 1 | 6,457 | 1,307 | 242 | +28% |
| Serverless | 1 | 729 | 189 | 89 | -11% |
Use this post, company, and trend context to find content marketing opportunities, perform competitive analysis, or address product feature gaps via the Plushcap MCP server or the Plushcap API.