Tech Writing – Using a Wiki For Your Technical Documentation Project

A wiki is really a collaborative writing software program with which an individual can setup the “wiki site” as well. With wiki’s powerful database, enhancing and messaging capabilities you as a new technical writer can accomplish much with regard to your technical conversation project.

You could, for example, post the drafts of the document on some sort of wiki site regarding review then invite your reviewers in order to post their remarks and feedback immediately onto the wiki. This reduces e-mail and phone visitors considerably. It can make certain both the writer as well as the gurus are literally on the same site.

You could configure different authorization and accessibility levels so that not everyone is able to notice everything, or give rise to every page. For The hidden wiki link , you can generate a special user class of “Reviewers” that can entry the review pages and leave reviews.

You can often go back to be able to my old version in addition to compare the growth of your doc since most wikis keep a backup copy of each and every version of your current pages. That sort of archival background may prove to be precious when tracking down a particular past version of your specific draft which might or may certainly not exist on the technological writer’s client piece of equipment.

You do certainly not need to possess total, complete essays and even articles to publish in a wiki. You could jot down quick ideas and recommendations and invite some others to elaborate plus build up on that. That way, the wiki can performance as a collective brainstorming tool as well.

Perhaps one involving the most significant functions of some sort of wiki is to be able to build a communautaire sense of possession, and pride within collective excellence. The past experience shows that will, once a group associated with people start to help with a wiki, they start in order to take the reliability and comprehensiveness details rather seriously. After the group starts in order to “police” itself, the particular job of your technological writer becomes a lot easier since typically the Subject Matter Experts begin to contribute upon their own, on your own, and the writer really does not need to be able to waste any time to track straight down specialized information anymore.

Author: quadro_bike

Leave a Reply

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