Labels: Helpful Tips, Knowledge Base
Here are a few suggestions to help you get started.
- Check for existing similar articles that you could comment on, or edit to update before starting a new one so as to avoid duplication.
- Build from Nominated Posts or Solutions in the Knowledge Base dashboard when possible - solutions in bold text do not yet have an associated article. Thread titles in normal text have at least one article based upon them already.
- Start articles from scratch when you have a unique solution, or a How-to article to contribute and no related solution or thread exists already to draw from.
- Select topics / threads that will help build an article that will be broadly valuable. Ask yourself if others are likely to encounter the situation your article applies to. Go through the forum to see if a post is a solution, and if so, mark it as such. This will help others locate suitable topics on which to build articles.
- Provide an appropriate context - for example, if building an article about an older issue that was solved with updated drivers or BIOS, there may be even newer versions now available. Be sure to reference using the version that solved the issue or later version.
- Enumerate the steps required in the solution if there is a procedure.
- Include pictures or embedded YouTube video that demonstrates the symptom, solution, or "how to" proceedure that your article covers. Relevant pictures improve comprehension and value.
- Create articles based on existing related discussions and solutions of the topic you want to create where possible, so that the content of others can be credited automatically in the article.
- Select relevant labels to help categorize your article and make it easier for others to find it once published.
- Select the best template for your article. Q & A and Solutions templates are best to build problem solving / answer articles, while freeform is best for general information sharing, installation / upgrade "How To" articles.
- Adopt the KISS principle in writing - Keep it Short and Simple, so that the article is accessible to users of all technical levels.
- Leave comments for others to help improve articles - focus on adding information, or offering corrections. Avoid open criticism - offer encouragement for change. Think about the kind of feedback you would like to receive on your article.
- Save incomplete drafts and look for drafts of others that you can add information to. Be respectful in your edits as you would expect others to treat your articles. Make use of revision notes section.
- Save and request review to publish.