Article-writing Tips

100% helpful (1/1)

This article will help you put your thoughts and ideas together to write an article for the Anaplan Community. It covers article structure, some helpful hints, and an example so you can get a better idea of what the steps look like.

Title:

Writing a good title is important. It should give users a good idea of what the article is about, but it needs to be short and to the point. 

Community category (knowledge base):

Where does the content fit in the Community? Examples include:

  • Anaplan Best Practices > Data Hub Best Practices
  • The Anaplan Way Guide > Implementation Phase

What is the purpose of this article?

Write a sentence or two that explains the purpose of the article. If there are benefits to the approach, include them here. This will help you stay on track. Examples Include:

  • It provides the information a model builder needs to set up a numbered list.
  • It explains the concept of sparsity.
  • It provides an overview of ALM.
  • It documents the requirements for setting up a data hub.

Introduction

The introduction is a short paragraph that provides an overview for the reader. It is something that a Community user can read and determine if the article is what they were looking for. It may be helpful to write this last, once you have your other thoughts in order, since the introduction needs to provide the reader with an accurate expectation of what is to follow.

Body

You’ve written the purpose of the article. The next step is to put some big ideas on paper: create an outline of the points you want to make in the article. If you are documenting a process, include the main steps and number them if they must be done in a certain order. No need to write full sentences at this point; just get your ideas down.

Keep your audience in mind. What do they need to know? What details do they need? What questions or concerns might they have? Are there certain issues (gotchas) that they need to be aware of? Are there other resources you can provide to help them get up to speed?

Once you’ve got an outline done (your list of main ideas), sort or organize the flow of the ideas. If you are documenting a process, this might be an easy task. If you are providing information, think about organizing the information by asking yourself "what does a reader need to know before they can understand this?" Organize by starting with the key information a reader needs to know and building from there.

Draft

Now take your organized outline and write a draft. Do this quickly—put your words and phrases from your outline into sentences and paragraphs. Focus on expressing your ideas. At the end of this step, you’ll have a rough draft. If you are not facing a deadline, save your draft, set it aside to focus on other work, and review it later.

Revise your draft by looking at three key areas. Ensure that:

  • the overall flow of the document makes sense.
  • language is clear and concise. Words should generally be short, informal, and concrete. (Do not use "fuzzy words;" make sure that your meaning is clear.) The sentences should mainly be short and simple.
  • you have used a positive, friendly and respectful tone.

Final review

Your article is coming together! Just a few more final steps. 

Start by running spell-check. 

Next, review your document to see if it follows these guidelines:

  • It identifies a clear purpose and achieves it
  • Any processes it outlines work as written
  • Its content is organized for learning
  • Its language is clear and concise
  • Its tone is friendly, respectful, and audience-appropriate

If you are working with a Community Content Manager, they will perform this final review.

Draft outline:Outline.png

Draft of the body of the article:

completed article.png

Note that this example is just a portion of an article. If you want to read the full article, visit Dashboard settings for improved model performance.

Labels (1)
Version history
Revision #:
12 of 12
Last update:
‎04-18-2018 10:17 AM
Updated by: