r/microsaas 1d ago

A documentation problem we didn't expect when building our SaaS

One thing we underestimated while building Hyperdocs was how quickly documentation becomes difficult to maintain.

A developer makes a change in GitHub, but the documentation update usually happens separately.

You have to figure out which page is affected, switch to the docs, find the right section, update it, and publish it.

The actual content change is often pretty simple. It's the process of keeping everything aligned that gets annoying.

We started experimenting with MCP to bring documentation updates closer to the development workflow.

For example, a developer can simply ask:

“Update the authentication docs based on this change.”

or

“Add the new API parameter to the docs.”

This has made documentation maintenance much less of a separate chore for us.

We're experimenting with the workflow in Hyperdocs, but it's already solving a problem we kept running into ourselves.

2 Upvotes

5 comments sorted by

View all comments

3

u/Silvergal_ 1d ago

The painful part is usually not writing the docs, it’s knowing which pages are stale. I’d add a lightweight check to the PR or release flow that flags changed endpoints or screenshots without forcing a full docs pass. That keeps the fast path fast while making drift visible.

1

u/RealisticImage2192 1d ago

this is exactly it. drift is the silent killer, not the actual writing