Best-practices Guide-
The best practices guide will simply go over a few key points to make sure the user feels somewhat confident in adding their own entries into the associated topics within the Wiki Link website. To best guide you through this Wiki, you must first know why Wiki links exist, and for what their main purpose actually is.
What- Wiki is a type of web-content management software that is designed as a collaborative system, allowing users to create and collaboratively edit pages or entries from a web-based platform.
Why- So the ‘why’ we use a Wiki link software over another type of software is simply due to the fact that Wiki's are super user-friendly, and offer a centralized content management system that allows for the integration of workflows and the enhancement of onboarding, the process of integrating new employees into a company.
Once knowing the actual purpose of the Wiki software it will be easier to understand the best-practices guide, since you now know the ‘what’ and ‘why' of what we are doing.
How- When adding quality entries into a Wiki Link discussion topic here are a few things you should always keep in mind: Know your audience, plan your document, gain technical knowledge on the discussion at hand, make the entry and experience of reading it-interactive, and make sure to follow grammar AND writing rules when conducting a new response. Ie. its best to remember the 7 C's of Technical Writing:
Clear, Concise, Concrete, Correct, Coherent, Complete, and Courteous
Clear Writing: is meant to convey the purpose of the document immediately to the reader. It involves knowing what you want to say before you say it. This is because a lack of clarity often comes from unclear thinking or poor planning skills.
Concise Writing: uses the least words possible to convey the most meaning while still maintaining clarity. Avoid unnecessary padding, awkward phrasing, overuse of “to be” forms (is, are, was, were, am, be, being), long preposition strings, vagueness, unnecessary repetition and redundancy.
Concrete Writing: involves using specific, precise language to paint a picture for your readers so that they can more easily understand your ideas. If you have to explain an abstract concept or idea, try to use examples, analogies, and precise language to illustrate it. Use measurable descriptors whenever possible; avoid vague terms like “big” or “good.”
Correct Writing: uses standard English punctuation, sentence structure, usage, and grammar. Being correct also means providing accurate information, as well as using the right document type and form for the task.
Coherent Writing: ensures that the reader can easily follow your ideas and your train of thought. One idea should lead logically into the next through the use of transitional words and phrases, structural markers, planned repetition, sentences with clear subjects, headings that are clear, and effective and parallel lists.
Complete Writing: includes all requested information and answers all relevant questions. The more concrete and specific you are, the more likely your document will be complete as well. Ie. Review your checklist of specifications before submitting your document to its intended reader.
Courteous Writing: entails designing a reader-friendly, easy-to-read document; using tactful language and appropriate modes of addressing the audience; and avoiding potentially offensive terminology, usage, and tone.
Disclaimer - All the information for the 7 C's of Technical Writing was pulled from OpenOregon Educational Resources Database.