Tech Writing – What Will need to a Good Documentation Wiki Web site Look Like?

Let’s say you decided for you to set up a technological writing wiki site to guide your document projects. What exactly should be the coins you should be trying to find? Here are some involving them…

Ease of Setup. Quite a few wikis are consequently complicated to run that you needed better look for a computer professional to do it in your case. But others are significantly simpler to help put in. In addition to some web hosting firms offer a one-click unit installation on their server. Select a wiki that is definitely appropriate for your stage of complex experience.

Internet browser Independence. Your current wiki site should display screen exactly the same in all well-liked browsers, with all it has the functions enabled. An official person should be able to edit all often the document pages you write-up no matter the browser type.

Automotive Internet Links. You should be able to page all your wiki web pages by simply default without placing almost any HTML codes straight into the origin code involving your pages.

Revision Control. The hidden wiki url ought to retain the backup backup associated with every version of your document. That way you may always return back and recommend to an earlier variant for retrieval or perhaps assessment purposes.

Searching Ability. Your readers should be ready to search your own personal file pages by keywords and phrases. Get knowledgeable that several wikis use different lookup syntaxes.

E-mail Notification. Your own personal wiki should be able in order to mail an individual an pm any moment anybody improvements something with any site. This should end up being configurable simply by user class plus page type.

Customer Accessibility. You should be in a position to develop different consumer groups based on a access authorizations including ordinary “Visitors, very well “Writers, ” “Editors, inches Administrators, micron etc.

WordPress extension Choices. Does your wiki program accept several plugins to access and search your current database, graphic plugin to create diagrams and chart for your documentation websites, class meeting and followup wordpress plugin to coordinate group meetings together with distribute the moments, and so forth

Upload and Down load Functionality. You should be able to add and download any kind involving text, image and perhaps multi-media attachments from your wiki pages.


Leave a reply

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong>