Re: using a wiki as your primary authoring tool & delivery mechanism

Subject: Re: using a wiki as your primary authoring tool & delivery mechanism
From: "Sandy Harris" <sandyinchina -at- gmail -dot- com>
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 7 Jan 2008 08:01:40 +0800

Fiona Krycek <fiona -dot- krycek -at- gmail -dot- com> wrote:

> I am wondering whether anyone out there has experience using a wiki as their
> primary authoring tool and delivery mechanism.

No, but I spend a fair bit of time on various wikis, mostly Wikitravel, a
free online travel guide: http://wikitravel.org/en/Main_Page

> ... how
> best to make the wiki easily searchable (there's tons of information on it).

Good search is built into the mediawiki software

> There are also questions about whether we even want to push people toward
> searching or whether we should be expecting them to use our very lengthy
> table of contents, and so on and so forth.
>
> I unfortunately have little experience with wikis. Does anyone else? As my
> comments above might indicate, I'm primarily interested in navigation, but
> any other guidelines or best practices for doing documentation on a wiki
> would be appreciated. We are using MediaWiki software, if that helps.

There are going to be disagreements over content, perhaps sometimes
degenerating to "edit wars" where A changes the page one way, then B
changes it back, then A, ... Perhaps yours will not be as intense as
some on political or historical content, but they'll happen.

You need some policies to deal with those. Wikipedia talks about
"neutral point of view", Wikitravel "be fair", ... On every wiki I have
seen, each article has a talk page where such issues can be
thrashed out.

Will you have vandals? Many wikis do; wikitravel's pages on USA,
China, Isreal and "Gay and lesbian travel" have all had utterly
over-the-top rants turn up. Then we had a clown moving dozens
of pages to silly titles.

Should only registered users be allowed to edit in an effort to
restrict that?

--
Sandy Harris,
Nanjing, China
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.


Follow-Ups:

References:
using a wiki as your primary authoring tool & delivery mechanism: From: Fiona Krycek

Previous by Author: Re: [slightly OT] File protection from copying
Next by Author: Re: Tutor of ESOL
Previous by Thread: using a wiki as your primary authoring tool & delivery mechanism
Next by Thread: RE: using a wiki as your primary authoring tool & delivery mechanism


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads