Note that there are some explanatory texts on larger screens.

plurals
  1. PO
    text
    copied!<p>+10⁶ for a Wiki, it's the best solution I've found so far for documentation, especially technical documentation. IMO, the advantages of "good" Wiki engines over Office documents in a VCS are (but you're already aware of that as this features list is very close to your requirements):</p> <ul> <li>they are just faster and easier to use than Office documents in a VCS (no need to open the VCS client, checkout the latest version, optionally lock it, open word, save, check-in, release the lock)</li> <li>they are text based so you make diffs (unlike word) and this just a must have </li> <li>they offer notification mechanisms (e.g. mail, RSS) and so the information is pushed to you (unlike a VCS where you need to pull document when they are out of date)</li> <li>there is no "document locked by another user problem" because someone forgot to release it (if you are using exclusive lock which is often the case on documents that you can't merge)</li> <li>pages can be easily refactored, reorganized, assembled in bigger documents</li> <li>they are really collaborative</li> <li>they provide much better support for code (e.g. you can point directly on the source code in a VCS with much better formatting than in word)</li> <li>they can index the content of pages and attached documents (pdf, office docs, etc) and make it searchable</li> </ul> <p>The only issue I've faced when using a Wiki for documentation is that it's harder to version your documentation in the same time as your code (i.e. you deliver version x.y.z and want to "lock" the documentation of this version). I've used exports to solve this but it's not perfect.</p> <p>I've already worked with <strike>TWiki</strike> <a href="http://foswiki.org/" rel="noreferrer">Foswiki</a>, <a href="http://www.atlassian.com/software/confluence/" rel="noreferrer">Confluence</a> and <a href="http://www.xwiki.org/" rel="noreferrer">XWiki</a>. They are all "good" Wiki engines (as defined above) and all meet your requirements. So the final choice may just depend on your constraints (license, pricing, technology) and personal preferences.</p> <p>As of today, I'd choose Confluence if a commercial tool is an option, XWiki if not.</p>
 

Querying!

 
Guidance

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload