Technical Writing - What Should a Good Documentation Wiki Web site Look Like?

Let's say a person decided for you to set up a practical writing wiki site to back up your document projects. Just what should be the options contracts you should be looking for? Here are some connected with them...

Ease of Installation. A few wikis are hence complicated to put in that you would better get a computer manufacture to do it for yourself. But others are significantly simpler to be able to put in. And some web internet hosting companies offer a one-click unit installation on their server. Pick out a wiki that can be appropriate for your stage of technical skills.

Internet browser Independence. Your own personal wiki site should screen precisely often the same in all favorite browsers, with all it has the attributes enabled. A authorized end user should be capable to edit all often the report pages you article in spite of the browser type.

Automobile World wide web Links. You will need to be able to link all your wiki websites by simply default without entering just about any HTML codes straight into the supply code associated with your pages.

Revision Supervision. Your wiki will need to keep a backup clone regarding every version of the doc. That way you can certainly always go back and refer to an earlier edition for retrieval or even evaluation purposes.

Searching Ability. You and your audience should be equipped to search the report pages by keyword phrases. Be informed that distinct wikis use different seek syntaxes.

E-mail Notification. Your own personal wiki should be able to help send out you an mail just about every time anybody improvements something upon any page. This should become configurable by way of user category in addition to page type.

Person Accessibility.  Hidden wiki  should be ready to create different person groups based on a access authorizations including ordinary "Visitors, inch "Writers, very well "Editors, inches Administrators, very well etc.

Wordpress plugin Choices. Does your wiki software accept several plugins to access and lookup your database, graphic plugin for you to create diagrams and chart for your paperwork pages, team meeting and follow-up tool to coordinate meetings in addition to distribute the mins, etc .

Upload and Down load Functionality. You should always be able to transfer and download any kind connected with text, image and actually multi-media attachments from the wiki pages.