Techie Writing – Using a Wiki For the Technical Documentation Project

A wiki is really a collaborative writing software program with which you can create the “wiki site” seeing that well. With wiki’s powerful database, croping and editing and messaging capabilities you as some sort of technical writer will accomplish much regarding your technical communication project.

You could, intended for example, post typically the drafts of your own document on some sort of wiki site for review and after that invite your reviewers to be able to post their feedback and feedback immediately onto the wiki. This reduces email and phone targeted traffic considerably. It tends to make sure that both the particular writer as well as the reviewers are literally on the same site.

You could configure different authorization and entry levels so of which not everyone can observe everything, or lead to every page. For example , you can create a special consumer class of “Reviewers” that can access the review webpages and leave remarks.

You can often go back in order to a previous version and compare the enhancement of your doc since most wikis keep a back-up copy of every single version of your own pages. That kind of archival record may prove in order to be precious if tracking down a particular past version of your specific draft which might or may not exist within the technical writer’s client model.

You do not necessarily need to have full, complete essays plus articles to post on a wiki. You could jot down speedy ideas and recommendations and invite some others to elaborate and build through to it. That way, some sort of wiki can performance as a collective idea tool as well.

Perhaps The original hidden wiki involving the most essential functions of a wiki is in order to build a communautaire sense of title, and pride inside collective excellence. Yesteryear experience shows that, when a group of people start to contribute to a wiki, they start to take the reliability and comprehensiveness info rather seriously. As soon as the group starts to be able to “police” itself, the job of any specialized writer becomes significantly easier since the particular Subject Matter Experts start off to contribute upon their own, on your own, and the writer truly does not need in order to waste any period to track along specialized information anymore.