Hacker News new | ask | show | jobs
by kaycebasques 1677 days ago
As I read through these comments (and discover some interesting tools!) I want to give a word of caution for anyone using this thread to make a tooling choice. The "best" documentation system for you is heavily dependent on your product [1], your contributors [2], and your ability to maintain/customize the underlying tooling. Just because you're seeing Tool X 10 times in this comment doesn't necessarily mean it's best for you!

[1] E.g. documenting an API is very different from documenting a GUI product

[2] E.g. on https://web.dev we had a large pool of authors. They were all fairly technical but even so we often ran into questions about build errors, etc.

1 comments

Agreed. I'm looking for documentation software that supports a WYSIWYG or otherwise visual editor. This is because the contributors to our documentation are not very technical.

If your contributors aren't technical then things that require Markdown, Git, or a build process are rejected pretty much immediately.

Currently I'm looking at Mediawiki or WordPress, but I'd love some other suggestions for non-technical contributors.