Company
Date Published
Author
Philip Kiely
Word count
1014
Language
English
Hacker News points
None

Summary

The author joined Baseten in January 2022 as a technical writer, impressed by the company's high-quality writing despite being heads-down on product development. The team needed to create best-in-class documentation that grew and evolved alongside the product, involving engineers in the creation process. They evaluated various solutions, including GitBook, Read the Docs, and self-hosting with Docusaurus or MkDocs, before settling on a "docs as code" approach using GitBook's GitHub sync, which allowed for version-controlled publishing, pull requests, build previews, and automated testing. The setup was quick and painless, but required additional work to address serving images and assets, including moving them to AWS S3 and Loom for screencasts. The author implemented a documentation style guide, meta-documentation on contributing docs, and incorporated documentation tasks into their work tracking system, enabling the team to create high-quality documentation that satisfied all stakeholders.