Hacker News new | ask | show | jobs
by jason2323 1249 days ago
I mean this seriously, consider moving documentation to your version control system and save your documentation in markdown. Markdown is powerful enough to format and store documentation of most forms you might need, combine that with a VCS of your choice and you’re set. All documentation changes are tracked and stored alongside your code changes. As a bonus, you won’t have to pay atlassian or deal with the clunky confluence UI!
3 comments

Companies don't only use Confluence as a documentation wiki. That's often the least of the use.

Think "Intranet CMS". Announcements, event signup pages, "feelgood stories", all kinds of digital resources, and all with lots and lots of macros.

Sales won't commit their success story with a customer to your git repo. Marketing won't share their corporate design templates in your git repo.

Markdown is not very good for tables for example. Both its syntax and the options it supports for tables are far from being enough to replace what you usually find a wiki system.
> Markdown is powerful enough to format and store documentation of most forms you might need

I find AsciiDoc to be more robust, but I agree broadly that using text-based documentation in version control – and, ideally, published via the same kind of VCS-driven automation you’d use to build and pubish software from source – is the best way to do things.