Hacker News Reader

>Engineers dabbling in documentation and feeling lost as they approach the field, on the other hand, are drawn to docs frameworks because frameworks are all they’re used to working with

Im drawn to frameworks because without them I cannot implemented an automated way to address the problem of docs going out of date.

View on HN

I have an issue with this because a lot of my internal documentation is drawings at various layers of detail. For whatever reason this is what works for me, and it appears to help other people on my team. But they always lag. I've tried committing svgs (useful but immediately out of date) and I'm now using mermaidjs in markdown (because github now renders these in the browser).

Do you know any framework/tool that would keep my drawings up to date? Maybe a pre-commit hook or github action that would check invariants in the code and fail to build without modifying the pictures?

That depends on what the drawings are of.

Docs frameworks (conceptual, theoretical ones) don't really solve the problem of docs going stale. Better processes and hiring tech writers do.

Reply on news.ycombinator.com