Question
How do I start writing a new article? What are some things to consider when I am writing?
Solution
Try to write for the audience that you intend for the article. However, make sure that anyone can read it and be able to understand it.
Some guidelines
The Knowledge Base Style Guide uses the University Communications' resource on Writing for the Web. Here are some guidelines from their resource.
- Optimize content and presentation so that users can find what they need quickly.
- Include the most important points in the first two paragraphs on the page.
- Use headings and subheadings.
- Start headings and subheadings with key words.
- Visually group small amounts of related content.
- Use bold and italics sparingly to emphasize words or phrases.
- Ensure links include information-bearing words (instead of generic “go”, “click here” or “more”).
- Use bullets and numbers to call out items in a list or process.
- Cut unnecessary content.
Additionally, the National Archives' article on plain language has the following guidelines.
Plain language is clear, concise, organized, and appropriate for the intended audience.
- Write for your reader, not yourself. Use pronouns when you can.
- State your major point(s) first before going into details.
- Stick to your topic. Limit each paragraph to one idea and keep it short.
- Write in active voice. Use the passive voice only in rare cases.
- Use short sentences as much as possible.
- Use everyday words. If you must use technical terms, explain them on the first reference.
- Omit unneeded words.
- Keep the subject and verb close together.
- Use headings, lists, and tables to make reading easier.
- Proofread your work, and have a colleague proof it as well.
Need help?
Please reach out to Knowledge Management Support or select Request Help with any additional questions you might have.