Wikis – The Best Tools for Documentation and Specifications

Writing documentation and specifications for developers is a big part of my day job.  Writing clear, concise documents is very challenging.  It’s one thing to write notes for yourself, quite another to explain complex systems and the desired outcome to others.  Not only is determining a format or standard way of writing things important for clarity, but so too, are the tools one uses to communicate.  This post will focus on the tools for sharing  documentation and specifications.

The standard documentation and specification writing tool of most businesses is Microsoft Word, Visio for diagrams, and Excel for spreadsheets — or other similar tools such as Open Office, Apple’s Pages, Numbers and the Omni Group’s Omnigraffle.  I have used all of these, but found each lacking in one fundamental way; they make ongoing “knowledge transfer” difficult, if not down right impossible.

DokuWikiWhen I say “knowledge transfer”, I mean the ongoing care and feeding of systems, troubleshooting a problem or implementing an enhancement to an existing system, or set of systems.  Unless the developer, project manager or end user knows where to find the original documentation, be it a specification or write up of a process, it is much more likely that these individuals will seek out any human specialist thought to know about this program or system first and ask for a verbal “download” and knowledge transfer meeting.  Not really something that is efficient in the long run as it relies on the ongoing staffing of these so-called specialists.  I for one don’t want to be the first stop for questions about systems and programs I have documented in the past — I want my documentation to be the first thing end users turn to for help and guidance.  Document management tools such as SharePoint, LiveLink and others help by providing a search function, but I have yet to see anything beat a simple wiki for knowledge transfer.  (My favorite wiki being DokuWiki.)  Hands down, they win out.

Let’s compare using SharePoint and Word/Visio/Excel to using a wiki to better clarify this comparison.  When using SharePoint, an end user can search the contents of the SharePoint site and get a really excellent search results set showing screen previews of Office documents, filters for last updates and more.  (Truly, the search results in SharePoint are great.) However, if all of the information is stored in a file, the file must be downloaded, or at best viewed online and edited with browser plugins.   A large dataset of Office files also becomes something that must be indexed regularly and is processor intensive.  What’s more, there’s ample opportunity for the document to be shared with others outside of the document management tool which may be seen as beneficial to some people, but for me is tantamount to storing the same data in several places with things quickly getting out of sync.

If all of the documentation is done directly in an easy to read, highly searchable wiki page, then even the questions the end user may have can be added directly in the document with updates and improvements to the documentation being done by the community of users.  Every wiki I’ve ever seen tracks changes well and is extremely searchable – this is exactly what wikis were created to do.  There is no additional application needed, you just use a web browser.

So why not use a wiki for both your documentation, specifications and runbooks all in one fell swoop?  If even somewhat organized into separate namespaces, a single wiki can provide an organization with a very powerful knowledge transfer tool that doesn’t require any desktop application or special licenses.  Diagrams are really the only tool one needs an application for to create outside of the wiki.  (I would also argue for using a diagraming tool such as Open Office’s drawing tool, Visio or Omnigraffle – a future post on diagraming seems like a good idea.) A single reference point for all documentation helps prevent fragmentation of the process documents and helps facilitate a culture where knowledge transfer is done routinely, and information hoarding is no longer the norm.

[I’ll be updating this post shortly with some tips for how better to construct a wiki page, too.]

 

2 thoughts on “Wikis – The Best Tools for Documentation and Specifications

  • June 8, 2017 at 6:58 AM
    Permalink

    good post, did you write anything on diagrams? in the data architecture community, diagrams are a must, we’ve been using visio and other tools, and we simply upload them to sharepoint, I can see that there are plugins available but some of them have not been updated over 2 or 3 years, any recommendations here?

    Reply
    • June 8, 2017 at 7:30 AM
      Permalink

      Hi Saul – -thanks for the note. I like Omnigraffle for my diagramming on a Macintosh — it’s not open source, but it is very powerful and exports an XML document for Visio users. Here’s my write up on Omnigraffle.

      In the Open Source world, Libre Office / Open Office does have a drawing tool and will import Visio as well. I used it for several years, but have been a strong proponent of Omnigraffle at work.

      Reply

Leave a Reply

Your email address will not be published. Required fields are marked *