In plain words: A guide written for AI coding assistants is attached to each question, giving it the library details it needs instead of hunting through human docs or web search. Tests on several libraries reached near-perfect success, with one case hitting 100% for all tested assistants.
Abstract · ReadMe.LLM: A Framework to Help LLMs Understand Your Library
Large Language Models (LLMs) often struggle with code generation tasks involving niche software libraries. Existing code generation techniques with only human-oriented documentation can fail -- even when the LLM has access to web search and the library is documented online. To address this challenge, we propose ReadMe$.$LLM, LLM-oriented documentation for software libraries. By attaching the contents of ReadMe$.$LLM to a query, performance consistently improves to near-perfect accuracy, with one case study demonstrating up to 100% success across all tested models. We propose a software development lifecycle where LLM-specific documentation is maintained alongside traditional software updates. In this study, we present two practical applications of the ReadMe$.$LLM idea with diverse software libraries, highlighting that our proposed approach could generalize across programming domains.
Sandya Wijaya, Jacob Bolano, Alejandro Gomez Soteres, Shriyanshu Kode, Yue Huang, Anant Sahai
arXiv:2504.09798 · cs.SE · submitted Apr 14, 2025 · updated May 8, 2025
abstract · pdf · html · 15 pages, 18 figures