Code-to-docs
When a developer checks in code, the docs update themselves—new articles, release notes, and a reviewer in the loop.
I've found that the hardest part of product documentation isn't writing it. It's keeping it updated.
I've been building my own documentation platform, and this week I added code-to-docs functionality. When a developer checks in code, the platform detects what changed, updates the relevant docs, writes new articles if they're needed, and drafts a release note for any UX or material change. Then it sends everything to a reviewer to publish.
No one has to remember to update the help article. No changes slip through the cracks. The docs just stay current.
I can't believe it's so easy to build this stuff yourself. I'll be adding the code to my GitHub once I'm finished with my MVP.
Watch the video below to see it in action 🎬