views:

763

answers:

13

I work on a complex application where different teams work on their own modules with a degree of overlap. A while back we got a Mediawiki instance set up, partly at my prompting. I have a hard job getting people to actually use it, let alone contribute.

I can see a lot of benefit in sharing information. It may at least reduce the times we reinvent the wheel.

The wiki is not very structured, but I'm not sure that is a problem as long as you can search for what you need.

Any hints?

+2  A: 

Sell the idea of using the wiki to the developers. You've identified some benefits, share those with the developers. If they can see that they'll get something of value out of it they'll start using it.

Example advantages from What Is a Wiki

  • Good for writing down quick ideas or longer ones, giving you more time for formal writing and editing.
  • Instantly collaborative without emailing documents, keeping the group in sync.
  • Accessible from anywhere with a web connection (if you don't mind writing in web-browser text forms).
  • Your archive, because every page revision is kept.
  • Exciting, immediate, and empowering--everyone has a say.
David
+6  A: 

As I mentioned before, a Wiki is very unorganized.

However, if that is the only argument from your developers, then invest some effort to create a simple index page and keep it updated (either do it yourself or ask people to link their contributions to the index). That way, the Wiki might grow into a very nice and quite comprehensive collection of documentation for all your work.

HS
A: 

Find "sticky" items (sub-3 pg. docs / diagrams / etc) something that the team seems to be creating again and again & post it on the wiki. Make sure everyone has access to the wiki and knows its there - set up a notification mechanism if possible. With some luck, the next time they have to access, rather than dig it out of version control or their machines - they should hit the wiki. If they still don't, try to see if the team has enough slack to actually use the wiki - Subtler issues may lie beneath their reluctance.

Gishu
+3  A: 

You can't force developers to do something they do not have an incentive of using for; unfortunately wikis, like documentation (well, in fact wikis are documentation) rarely have any "cool" value for developers. Besides, they're already deep into dev work -- could you really bother them with a wiki?

That being said, the people who pushed for the wiki (e.g., you) should be primarily responsible for updating it, and you really would have a lot of work cut out for you if you're serious about it.

You might also try the ff:

  • It's not very structured you say -- a lot of people get turned off from ill-structured (hard-to-search/browse) wikis. So maybe you can fix that first
  • Maybe you can ask lead developers/project managers to populate it with things that are issues for them: things like code conventions and API design for your particular project
  • Lead by example: religiously document your part of the system. Setting a precedent may encourage others to do the same
Jon Limjap
+2  A: 

I have done some selling and even run some training sessions. I think some people are turned off by the lack of WYSIWYG editing and ability to paste formatted text from Word or Outlook. I know there are some tools to work around these, but they are still barriers.

There are some areas where the wiki is being used to log certain areas, but people who update those are not doing anything else with it.

I will use the wiki to document my specialised area regardless as it acts as a convenient brain extension. When starting a new development I use it as a notepad for ideas that I can expand on as it progresses.

It would help if management would give it some vocal support, even if it is not made mandatory.

steevc
Not true anymore: there are WYSIWYG wiki. e.g. Wikiwig
Berry Tsakala
I'm using a CKEdit WYSIWYG plugin for MediaWiki that's quite nice:http://www.mediawiki.org/wiki/Extension:FCKeditor_%28Official%29
mskfisher
+6  A: 

We've been using a wiki in some form or another for a while now, but it does take a while for people to get on board. You might find that you will be the only one writing articles for some time, but bear with it, other people will come on board eventually.

If someone sends an email around that contains information related to the project then helpfully point them in the direction of the wiki - and keep doing that - they should get the hint.

We have a SharePoint portal and use the wiki from there - we customised it with our own branding so that it "looks the part" - I really feel this has helped to improve the uptake of it.

Make sure that everyone is aware that the wiki is even more informal than email.... because there will be a "fear factor" that people may think anything they add to the wiki will be over-analysed.

Duncan
+4  A: 

I think most of the answers so far are spot on - the more you plug away at it yourself, the larger the body of useful information will become, so slowly but surely people will naturally start to use it.

The other approach you could use is this: Suggest that every time someone asks another team member a question about the project, they should answer the question as normal, but also add the answer to a section of the Wiki. This may take a few minutes extra, but it will mean that the next time someone asks the same question (which they inevitably will), you can save time by pointing them at the Wiki. This, in turn, should help people to start using the Wiki as a first source of information and help overall up-take.

Chris Roberts
A: 

Take a look at the advice at http://www.ikiw.org/ Grow your Wiki

nanek
A: 

Just to add to some of the excellent advice being offered here...

As a dev in a small company that does largely gov't contract work in the 6-24 month range, I find that my time is often split between development and writing status reports (right up there with writing documentation, only worse!) Having a wiki to slap down unorganized thoughts and notes as we go along has made report-writing a lot less painful (not pain-LESS, but better all the same).

Further, if you're already in the Mediawiki world, you might want to look at SemanticMediawiki. It allows you to take the organization of your data to another level by semantically tagging it. That doesn't mean a lot on its own, I know, but I can tell you (for example) that it can drastically improve the relevance of the data returned from searches. It is definitely worth a look.

+13  A: 

Some tips:

Any time someone sends information by email that really should be in a wiki, make a page for that topic and add what they put in the email. Then reply "Thanks for that info, I've put it into the wiki here so that it's easier to find in the future."

Likewise, if you have information you need to share that should be in the wiki, put it there and just send an email with a link to it, rather than email people.

When you ask people for information, phrase it so that putting such documentation in the wiki should be considered the default or standard: "I searched in the wiki but I couldn't find it. Have you put that info up there yet?"

If you are the "wiki champion", make sure other people know how to use it, e.g. "Did I go through how to create a new page with you yet?"

Edit the sidebar to make sure it is relevant to your work.

Use "nav box" style templates on related pages for easier navigation.

Put something like {{Special:NewPages/5}} on the front page, or recent changes, so that people can see the activity.

Take a peek at Recent changes every few days or week, and if you notice someone adding information without being prodded, send them an email or drop by and give them a little compliment.

pfctdayelise
I do a lot of those things already. Our QA and implementation departments are starting to use the wiki, so there's hope. I'd like to see more developers documenting modules they work on. I'll keep doing that if only for my own benefit.
steevc
The correct syntax to limit item count for {{Special:NewPages}} is {{Special:NewPages/5}}
Abtin Forouzandeh
Thanks Abtin - corrected now
pfctdayelise
+1  A: 

I have a hard job getting people to actually use it, let alone contribute.

One of the easiest ways to get people to contribute to a wiki, is to actually have them provide contents in a wiki-suitable fashion, i.e. so that whatever they post using their usual channels of communications (newsgroups, mailing lists, forums, issue trackers, chat), is basically suitable for inclusion on the wiki.

So that others (users/volunteers) can simply take such contents and put them on the wiki.

This sounds more complicated than it really is, it's mostly about generalizing questions and answers, so that they are not necessarily part of a conversation, but can be comprehensible, meaningful and useful in a standalone fashion.

For example a question like the following:

how do I get git to clone a remote repository???

Can be answered like this:

Hello, Just use git clone git://...

But questions can also be answered in a less personal style:

In order to clone a git repository, you will want to use the clone parameter to git: git clone git://....

What I am trying to say is that most discussions in a project can and should be easily used to become documentation eventually. With this sort of mindset, your documentation can actually grow rather rapidly. You only need to get people to keep in mind that useful information should be ideally provided in a fashion that is suitable for wiki inclusion.

I have witnessed several instances where open source projects started to use this approach to some extent and while some people (largely new users) complained that answers were not very personal, the body of documentation was increasing steadily, because other people simply monitored such discussions and started to copy/paste such responses to the wiki.

Basically, this is one of the easiest ways to get people to contribute to a wiki, without requiring them to actually use it themselves, the only thing that's required of them is a shift in thinking.

none
+1  A: 

If the developers still need to maintain 'real' documentation (s.a. Word documents), I see no way to meaningfully duplicate that on a Wiki.

  • It does not make sense for people to write twice
  • Any duplicated data is prone to get out of sync, soon.

What my current customer has done is move all this to Wiki. So I only document once, and I do it on the Wiki.

This is okay. Working with Wiki is more tedious than with Word, but at least the doc is online and others can mix-and-match with it.

Another working solution (imho) would be to store docs alongside the source, on subversion. But then the merging system needs to be able to cope with rich text etc. as well. I don't know, if any solution for that exists (other than using HTML or LaTex, which actually would not be bad picks).

akauppi
A: 

Generally good advice here. I'd like to add:

  1. You really need a champion - someone pushing this to developers and management (without being pushy - that's a challenge!) and providing support & tutorials when possible. This person also needs to be a peer (so a fellow developer, not someone in a remote IT department) and really customer focused i.e. ready to make changes when requested.
  2. Speaking of changes, some people here say wikis are unstructured. I disagree. Our MediaWiki installation is structured using categories, particularly with two extensions:WarnNoCategories (to require users to add a category when saving a page) and CategoryTree to show how all the categories fit together (this can be linked to from the sidebar). I've got more tips on how we keep this low threshold, if you're interested.
Mark Robinson
Mark Robinson