Why I keep rebuilding the same docs pages
Blog post from Fern
Devin, a technical writer at Fern, oversees the dynamic and evolving documentation of over 500 pages for Fern Docs and SDKs, which continuously undergo updates as new features are introduced. As documentation evolves, the challenge lies not only in updating content but also in ensuring that the page components such as callouts, accordions, and tabs are appropriately adjusted to fit the new information. The adaptation of documentation is highlighted through examples of pages that have evolved, such as the llms.txt page, which expanded alongside the feature it described, and the Fern Editor page, which transitioned from a promotional pitch to a setup guide as user familiarity increased. Similarly, the Go SDK publishing page was enhanced with additional context while maintaining its concise nature. These changes reflect the necessity of a consistent structure that aids both human and AI navigation, emphasizing the importance of thoughtful editorial decisions in maintaining clarity and usability in documentation.