Tech Writing - What Need to a Good Documentation Wiki Site Look Like?

Let's say anyone decided in order to set up a technical writing wiki site to guide your document projects. What should be the futures and options you should be looking for? Here are some connected with them...

Ease of Assembly. Many wikis are hence complicated to put in that you'd probably better discover a computer operator to do it for you. But others are significantly simpler to install. In addition to some web web hosting service organizations offer a one-click unit installation on their web server. Decide on a wiki that will be appropriate for your degree of complex expertise.

Browser Independence. Your own wiki web site should display precisely this same in all popular browsers, with all it is characteristics enabled. An official consumer should be equipped to edit all this record pages you blog post no matter the browser type.

Automotive World wide web Links. You should be able to net connection all your wiki internet pages simply by default without applying any kind of HTML codes into the origin code regarding your pages.

Revision Control. Your wiki have to maintain a backup backup of every version of your respective document. That way you can easily always return back and direct to an earlier version for retrieval or even assessment purposes.

Searching Ability.  Deep web links  should be able to search your current report pages by keyword phrases. End up being aware that several wikis use different search syntaxes.

E-mail Notification. Your own personal wiki should be able for you to give you an e mail every time anybody changes something with any web page. This should become configurable simply by user school and even page type.

Customer Entry. You should be equipped to create different user groups based on a access authorizations including simple "Visitors, inch "Writers, inch "Editors, inches Administrators, " etc.

Wordpress plugin Choices. Did your wiki computer software accept distinct plugins for you to access and look for your own personal database, graphic wordpress extension to be able to create diagrams and music charts for your paperwork internet pages, collection meeting and follow-up wordpress extension to coordinate conferences and distribute the mins, etc .

Upload and Obtain Capacity. You should end up being able to add together with download any kind involving text, image and possibly multi-media attachments from the wiki pages.