ARTICLE IDEA |
---|
Purpose of the article |
|
Specific information to cover |
|
Need / Urgency |
|
Formatting
Suggested headings
The headlines are suggestions on how to structure the article, making it easier for the reader to catch the information. If these headlines does not fit the need of the article, that is completely fine; Use the headlines that you need.
Suggested formatting
Please understand that this template contains mere suggestions of how an article should be shaped and formatted, and it’s content isn’t mandatory. That being said, if every article can stay close to a consensus, they will probably feel more familiar to the customer reading it.
General formatting
Try to stick to the basic formatting using the predefined text styles etc.
If applicable, use figures and images as part of the explanation. This will make the article easier to read and easier to understand.
The use of line shifts should be consistent:
Shift+Enter: This is a short line shift and should be used as line shift within an section of text if needed. For instance within one bullet point in a list:
This text is a short line shift below the rest of the text in this bulletpoint.Enter: This is a long line shift and should be used to separate different sections of text.
Bullet point bold title
If a bulletpoint is to hold a lot of text, it could be smart to use the first line as a title in bold letters, making it easier to read. This text body is separated from the bold title with a short line shift.
Table formatting
TITLE | ||
---|---|---|
Column #1 subtitle | Column #2 subtitle | Column #3 subtitle |
Content | Content | Content |
TITLE | ||
---|---|---|
Row #1 subtitle | ||
Row #2 subtitle | ||
Row #3 subtitle |
Tips & Tricks
# 'Code snippets' make code examples much easier to read. def has_awsm_article_feedback(feedback = ''): if feedback: print('No feedback available; hard to know if awsm!') else: print('Feedback available; read it to check if awsm!')
These kind of panels are really good to grab the attention of the reader when a piece of information is vital. For instance configurations that cannot be combined with the <topic> or common misconceptions.
These kind of panels are really good to grab the attention of the reader when a piece of information is vital. For instance configurations that cannot be combined with the <topic> or common misconceptions.
Delete this error block and everything above it once the article is finished!
Also remember to remove unused template sections, like tables or other formatting examples. All template text in red should also be deleted.
Summary
For longer articles it could be smart to start with a summary. That way, it’s easier for the customers to evaluate if this article holds the information they seek.
Table of Contents
What is <topic>
Explain what the functionality, feature, variable, etc. is, and what it does.
Benefits of <topic>
What are the benefits of using <topic>. Why should it be used?
Subchapter of <topic>
Subchapter of subchapter og <topic>
Subchapter of subchapter of subchapter of <topic>
How to use <topic>
How to apply whatever <topic>. Good relevant examples helps a lot!
One way to use the <topic>
Lorem ipsum…
Example 1
This is the first example.
Example 2
This is the second example.
Another way to use the <topic>
Lorem ipsum again…
Example
This is the only example.