Technical Writing – What Need to a Good Documentation Wiki Web-site Look Like?

Let’s say an individual decided for you to set up a complex writing wiki site to compliment your document projects. Just what should be The hidden wiki url should be looking for? Here are some associated with them…

Ease of Installation. Some wikis are thus complicated to setup that a person would better find a computer operator to do it to suit your needs. But others are significantly simpler for you to install. Plus some web internet hosting firms offer a one-click installation on their storage space. Select a wiki that is definitely appropriate for your levels of technological experience.

Web browser Independence. Your current wiki web page should display screen specifically the particular same in all well-known browsers, with all its capabilities enabled. The sanctioned person should be in a position to edit all typically the document pages you blog post in spite of the browser type.

Automotive Internet Links. You will need to be able to net connection all your wiki websites by means of default without inserting just about any HTML codes in the supply code regarding your pages.

Modification Administration. Your wiki should preserve a new backup content associated with just about every version of your record. That way you can certainly always turn back and direct to an earlier edition for retrieval or perhaps evaluation purposes.

Searching Functionality. Your readers should be ready to search your own personal record pages by keyword phrases. Be mindful that various wikis use different look for syntaxes.

E-mail Notification. Your own wiki should be able to be able to mail a person an e mail any time period anybody alterations something with any page. This should become configurable by way of user course plus page type.

User Gain access to. You should be capable to make different consumer groups with different access authorizations including basic “Visitors, inch “Writers, micron “Editors, micron Administrators, ” etc.

WordPress plugin Choices. Does your wiki program accept different plugins to access and lookup your own database, graphic plugin to be able to create diagrams and charts for your records webpages, collection meeting and a muslim wordpress tool to coordinate gatherings plus distribute the moments, etc .

Upload and Download Capacity. You should possibly be able to upload and download any kind regarding text, image and perhaps multi-media attachments from your own personal wiki pages.


Leave a Reply