Building docs like a product
8 days ago
- #user-experience
- #interactive-docs
- #documentation
- Stripe's product docs are highly regarded for their application-like design.
- Scour's docs include interactive elements, such as live search bars for Hacker News posts not on the front page.
- Interactive features are also available for Reddit, Substack, and arXiv users within the docs.
- The docs emphasize 'show, don't tell' by incorporating live examples and real components from the Scour website.
- Logged-in users can adjust settings directly from the documentation pages.
- The use of real components ensures consistency and avoids divergence between docs and the actual product.
- Scour's docs are built with Rust's axum HTTP routing library to prevent broken links, leveraging typed paths for reliability.
- Feedback from users has been instrumental in developing comprehensive documentation, including details on Scour's ranking algorithm.