Technical Writing What Should a Good Documentation Wiki Web page Look Like

From EECH Central
Revision as of 15:06, 26 June 2023 by Sawhemp0 (Talk | contribs) (Created page with "Let's say a person decided in order to set up a technological writing wiki site to guide your document projects. What exactly should be the futures and options you should be t...")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Let's say a person decided in order to set up a technological writing wiki site to guide your document projects. What exactly should be the futures and options you should be trying to find? Here are some involving them...

Ease of Setup. A few wikis are thus complicated to install that you'd probably better locate a computer manufacture to do it for you personally. But others are significantly simpler to help put in. And some web internet hosting corporations offer a one-click installation on their machine. Choose a wiki that is usually appropriate for your level of practical competence.

Browser Independence. Your own personal wiki web site should display accurately often the same in all well-liked browsers, with all it has the characteristics enabled. An certified consumer should be equipped to edit all typically the record pages you posting in spite of the browser type.

Car Net Links. You need to be able to web page link all your wiki internet pages simply by default without putting any kind of HTML codes into the source code connected with your pages.

Revising Administration. Your wiki need to retain a good backup backup of every single version of the file. That way you could always return back and send to an earlier variation for retrieval or maybe comparison purposes.

Searching Capacity. You and your readers should be able to search your current doc pages by keywords. Turn out to be conscious that several wikis use different seek syntaxes.

E-mail Notification. Your wiki should be able for you to give you an pm just about every time anybody adjustments something about any site. Hidden wiki url should be configurable by means of user category together with page type.

Customer Admittance. You should be ready to create different customer groups with various access authorizations including simple "Visitors, inches "Writers, inches "Editors, " Administrators, inches etc.

Wordpress plugin Choices. Does your wiki application accept several plugins to help access and search your own personal database, graphic wordpress tool in order to create diagrams and chart for your records pages, party meeting and , the burkha tool to coordinate conferences plus distribute the minutes, etc .

Upload and Acquire Ability. You should become able to publish and download any kind connected with text, image and also multi-media attachments from your own wiki pages.