Techie Writing - What Should a Good Documentation Wiki Site Look Like?

Techie Writing - What Should a Good Documentation Wiki Site Look Like?

Let's say anyone decided to be able to set up a complex writing wiki site to guide your document projects. Exactly what should be the futures you should be trying to find? Here are some of them...

Ease of Assembly. Many wikis are so complicated to setup that you needed better locate a computer manufacture to do it to suit your needs. But others are significantly simpler for you to install. And some web web hosting corporations offer a one-click unit installation on their machine. Pick out a wiki that is usually appropriate for your stage of specialized competence.

Web browser Independence. The wiki site should display specifically the particular same in all well-known browsers, with all the attributes enabled.  Hidden wiki  should be capable to edit all often the doc pages you posting regardless of browser type.

Automotive Internet Links. You have to be able to net connection all your wiki webpages by means of default without placing almost any HTML codes directly into the reference code connected with your pages.

Revision Management. Your wiki should maintain some sort of backup duplicate regarding any version of your respective doc. That way you could always return and refer to an earlier type for retrieval as well as evaluation purposes.

Searching Capacity. You and your audience should be capable to search your own personal file pages by key terms. End up being conscious that distinct wikis use different look for syntaxes.

E-mail Notification. Your wiki should be able to help give you an e-mail every time period anybody changes something in any webpage. This should be configurable by simply user class plus page type.

User Admittance. You should be ready to develop different user groups with various access authorizations including ordinary "Visitors, very well "Writers, inch "Editors, very well Administrators, inches etc.

Tool Choices. Did your wiki software accept different plugins for you to access and research your own personal database, graphic plugin to help create diagrams and music charts for your records websites, collection meeting and follow-up wordpress tool to coordinate group meetings plus distribute the mins, etc .

Upload and Acquire Potential. You should become able to upload and even download any kind connected with text, graphic and perhaps multi-media attachments from your own wiki pages.