Hacker News new | ask | show | jobs
by dnomad 2843 days ago
> SaaS-ifying your docs seems risky to me.

It strikes me as a really, really bad idea. Besides the obvious lock-in issues, I've found the only hope of keeping documentation uptodate is to either generate it from the code or keep it checked it in git besides the code.

What's really needed are (1) authoring tools that can produce decent documentation (ideally as docbook XML or maybe asciidoc) for checkin and (2) product guys who are willing to write docs for features before or during feature development and (3) translation services that can actually do a decent job between the big three business languages (English, Mandarin, Spanish).

It's frustrating that 1, 2, and 3 are so very hard to find. Many products live or die by their lack of documentation, but there don't be seem any simple solutions here.

1 comments

I'm happy to hear your feedback @dnomad. I'll be notifying you once we get to these challenges.