Tech Writing - What Should a Good Documentation Wiki Internet site Look Like?

Tech Writing - What Should a Good Documentation Wiki Internet site Look Like?

Let's say you decided to help set up a technological writing wiki site to support your document projects. Just what should be the futures and options you should be seeking? Here are some of them...

Ease of Installation.  hidden wiki  are thus complicated to install that you would better look for a computer operator to do it for you personally. But others are significantly simpler in order to mount. In addition to some web internet hosting companies offer a one-click assembly on their server. Select a wiki that is appropriate for your stage of complex experience.

Visitor Independence. Your current wiki web-site should screen precisely typically the same in all favorite browsers, with all the functions enabled. A sanctioned consumer should be in a position to edit all typically the document pages you article no matter the browser type.

Automotive Internet Links. You ought to be able to link all your wiki pages by default without putting virtually any HTML codes into the supply code connected with your pages.

Version Administration. Your wiki need to keep some sort of backup copy of just about every version within your document. That way you can certainly always get back and relate to an earlier variant for retrieval or even comparison purposes.

Searching Capability. You and your viewers should be in a position to search your current document pages by keywords. Become aware that different wikis use different seek syntaxes.

E-mail Notification. Your own wiki should be able for you to send out anyone an pm each time period anybody improvements something about any site. This should be configurable by user course plus page type.

Consumer Accessibility. You should be capable to develop different consumer groups with various access authorizations including simple "Visitors, micron "Writers, inches "Editors, " Administrators, " etc.

Plugin Choices. Does your wiki program accept diverse plugins in order to access and search your database, graphic wordpress tool to create diagrams and chart for your proof pages, collection meeting and a muslim wordpress tool to coordinate appointments and even distribute the minutes, and so forth

Upload and Acquire Functionality. You should always be able to post plus download any kind connected with text, picture and even multi-media attachments from your current wiki pages.