Project documentation in a WIKI

Project documentation is probably the most important part in science. Essentially, experiments and results that you don't document have been done in vain. Meanwhile, an electronic documentation has gained increasing attention, because the information is easy to write and format, easy to backup, and easy to share with other project partners. Popular examples are Markdown, jupyter solutions, or WIKIs. Certainly, you have visited wikipedia before, and we trust that you found it pretty helpful. So no need to introduce WIKIs and their importance.

We do the project documentation using a DokuWiki. The software is easy to install, DokuWiki pages are quickly generated, information can be easily entered, and your partners will see them as soon as you hit the Save button.

Of course, there are a couple of things to keep in mind when using a WIKI

• You need a computer, and when you access a WIKI via the web, you need an active internet connection
• Unsaved changes will be lost once you leave the page (or the computer crashes)
• Web-based access represents a security risk¹⁾
• WIKI-set up is not straightforward for everybody
• If you mix editing with the simple DW editor²⁾ and with the CKG editor³⁾, DokuWiki can do funny things. Essentially, it can start to mix the Wiki syntax, which is considerably easy to learn, with way more complex html code. You don't want that!!.

  Our advice

  Our advice

  Use the DW editor only, and learn the WIKI syntax

Click on the tabs to learn more