Technical Writing – Using a Wiki For Your Technical Documentation Project

A wiki can be a collaborative writing computer software with which an individual can create some sort of “wiki site” while well. With wiki’s powerful database, enhancing and messaging capabilities you as a technical writer may accomplish much regarding your technical interaction project.

You could, regarding example, post typically the drafts of your own document on a wiki site with regard to review then request your reviewers to post their remarks and feedback immediately onto the wiki. This reduces email and phone targeted traffic considerably. dark web links tends to make sure that both typically the writer and the testers are literally in the same web page.

You may configure various authorization and entry levels so of which not everyone can see everything, or contribute to every page. For example , you can generate a special user class of “Reviewers” that can accessibility the review web pages and leave remarks.

You can always go back in order to a previous version plus compare the enhancement of your doc since most wikis keep a back up copy of each and every version of your pages. That type of archival historical past may prove to be precious if tracking down a certain past version of the specific draft that might or may not exist on the technical writer’s client piece of equipment.

You do certainly not need to have complete, complete essays in addition to articles to publish about a wiki. You are able to jot down quick ideas and suggestions and invite some others to elaborate in addition to build up on this. That way, a new wiki can functionality as being a collective brainstorming tool as well.

Perhaps one regarding the most essential functions of a wiki is in order to build a collective sense of ownership, and pride within collective excellence. Days gone by experience shows that will, once a group associated with people start to be able to help with a wiki, they start in order to take the precision and comprehensiveness details rather seriously. Once the group starts to “police” itself, typically the job of the technical writer becomes significantly easier since the particular Topic Experts commence to contribute in their own, under your own accord, along with the writer does not need to waste any period to track lower specialized information ever again.

Leave a Reply