Technical Writing What Need to a Good Documentation Wiki Internet site Look Like
Let's say you decided for you to set up a technical writing wiki site to aid your document projects. What exactly should be the coins you should be searching for? Here are some associated with them...
Ease of Installation. Some wikis are so complicated to install that you'd better find a computer operator to do it for yourself. But others are significantly simpler to mount. Together with some web internet hosting businesses offer a one-click assembly on their storage space. Pick a wiki that is definitely appropriate for your levels of complex expertise.
Internet browser Independence. The wiki web site should show just the same in all well-liked browsers, with all its attributes enabled. A great sanctioned user should be capable to edit all the record pages you article no matter the browser type.
Automotive Internet Links. You ought to be able to web page link all your wiki internet pages by simply default without placing any kind of HTML codes directly into the source code of your pages.
Revision Supervision. Your wiki should retain a good backup content connected with every version of the record. That way you could always return and send to an earlier variant for retrieval as well as assessment purposes.
Searching Ability. Your visitors should be able to search the record pages by keywords and phrases. Become mindful that diverse wikis use different look for syntaxes.
E-mail Notification. Your own wiki should be able to help deliver a person an email each period anybody improvements something in any site. This should be configurable by means of user school together with page type.
Consumer Accessibility. You should be in a position to produce different person groups with different access authorizations including basic "Visitors, " "Writers, " "Editors, micron Administrators, " etc.
The hidden wiki url . Did your wiki software accept different plugins for you to access and look for your own database, graphic plugin to create diagrams and maps . for your proof web pages, party meeting and a muslim plugin to coordinate group meetings and distribute the minutes, etc .
Upload and Download Capability. You should always be able to post and download any kind of text, graphic and possibly multi-media attachments to and from your wiki pages.
