TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

Ask HN: How to maintain a killer product documentation page

5 pointsby kostareloalmost 3 years ago
Sometimes I&#x27;m being impressed by a very thorough, well structured, always up to date documentation page.<p>Stripes&#x27;, Slacks&#x27; and Jiras&#x27; documentation pages are the first three that comes into my mind (I&#x27;m sure people will have different experiences but still I&#x27;m sure lots of them will agree with me that these are exceptionally good documentation pages).<p>I&#x27;ve never been in an organisation where we were maintaining such pages and I&#x27;m not sure what is the process of writing them. On the contrary, my experience have usually been a state where the product requirements, the actual end product and the documentation being somewhat out of sync.<p>How would you describe the process of maintaining a great product documentation page?<p>Thanks :)

3 comments

zkirillalmost 3 years ago
We generate a static website using Hugo and a documentation theme. [1] Non-technical members of our team can use Markdown easily and publish changes on their own schedule thanks to a very simple but sturdy CI&#x2F;CD setup (GitHub Actions and NGINX).<p>Stripe&#x27;s documentation is way over-engineered and wasteful IMO, and probably requires a massive team to maintain.<p>[1] <a href="https:&#x2F;&#x2F;github.com&#x2F;alex-shpak&#x2F;hugo-book" rel="nofollow">https:&#x2F;&#x2F;github.com&#x2F;alex-shpak&#x2F;hugo-book</a>
superfreekalmost 3 years ago
It&#x27;s all about putting in the work. Not much programming expertise required.
p0dalmost 3 years ago
Good content and a good TOC.