IN THIS ARTICLE:
Overview
For full instructions on formatting an article, please review the Full Style Guide.
This is an example of an overview, it should be used to introduce the article and what the reader should expect below.
Article Heading & Contents Example
Each section should be broken up by a horizontal line and introduced with a heading, that is hyperlinked to the contents box at the top of the article with anchors.
All lists should be displayed with a bulleted list:
Item 1
Item 2
Item 3
If you need to describe a number of bits of information, bold each name, and describe the item, but not in a bulleted list:
Example 1: This is an example.
Example 2: This is an example.
Example 3: This is an example.
If you are giving instructions, they should be in a numbered list:
Instruction number 1.
Instruction number 2.
Instruction number 3.
However, if you only need to outline 1-3 short steps for the instructions, you can place the instructions in sentence format instead.
Modules, sections or terms from Rosterfy should be capitalised. (Shifts, Users, Events etc.)
When giving instructions, if you are advising the user to click on parts of the platform, for example Events tab, it should be bolded.
If you are giving consecutive instructions, you can separate using a right angled bracket (chevron), for example, click the Events tab > Events.
Note: If you need to highlight something, include it in a callout box.
Note: If what you need to highlight is important, make it a caution callout box.
Images, Gifs & Videos
If you need to break a section into smaller sections, utilise the heading 2 font type and include a hyperlinked list, not in a callout box:
Images
Include images within the instructions of what the user should be seeing. The example below is advising the user to click View Shifts.
All images should be captured within Rosterfy on Zoom level 67% to maximise the information displayed within the image.
Use a rounded edge square, in colour red, to highlight the area you want to highlight.
Gifs
If you are detailing a number of consecutive steps, include a gif of it in action (max. 30 secs).
Suggest to change your mouse icon to a large size, as per the below example.
Videos
If the article is a high viewed article (confirm with Krystal), contains in-depth instructions or is required for the Rosterfy website, create a video to accompany the instructions.
This should be a youtube video, embedded into the article.
Contact Krystal for the video template.
Linking to Other Articles
If instructions are already in another article, don't repeat them, hyperlink to the article.
Also if referencing other parts of the platform that have articles, hyperlink to those articles.
For referencing to information outside Rosterfy, include hyperlinks to external information for reference.
End of Article
The end of articles, should have a next action. For example, linking back to the Overview article for that module.
If the article is the Overview, the article should include a FAQ section at the end.
FAQ contents should be numbered with the questions, and linked to each question. Example below.
Details Tab
Complete the information on the details tab, as per below:
Fin: Ensure Fin and Copilot are turned on.
Collection: To match the module of the platform or journey of the reader.
Tags: Keywords used in the article, search terms for SEO.
Full Style Guide
Title:
Content: Clear and concise title for the area of the platform or action in the platform. Not to be posed as a question. Limit the number of words used.
Format: Title case* for capitalisation. In title case, major words are capitalised and most minor words are lowercase.
Subtitle:
Content: One to two sentences to describe the feature / function available within Rosterfy. Should have a very positive sales style feel to the subtitle, unless article is in reference to troubleshooting.
Format: No specific formatting required.
Contents Box:
Content: Hyperlinks for all headings within the article.
Format: Using a blue ‘Tip’ Callout box, introduce the document with “IN THIS ARTICLE:” in bold, followed by hyperlinks to all anchors within the page, with a bulleted list.
Headings:
Content: Break the article into bite size sections with headings to introduce them
Format: Heading 1 sized text option.
Body:
Contents: Body text of the article.
Format: Paragraph sized text option, short paragraphs, with lots of white space.
All lists should be displayed in bulleted lists.
If giving descriptions of a number of bits of information, bold each name but not in bulleted list.
Instructions should be in numbered lists. Unless less than 4 instructions, then can be in sentence form.
All names of modules, sections or terms within Rosterfy should be capitalised.
Any clickable instructions within Rosterfy should be bolded.
Can separate consecutive instructions with a right angled bracket (Chevron).
Include images to show what the reader should be seeing.
Include gifs to show a number of consecutive steps. (max. 30 secs)
If it’s a high viewed article, or contains in-depth instructions, or required for the Rosterfy website, create a video to accompany the instructions. The video should be a youtube video, embedded into the article.
Insert a horizontal line before each heading.
If instructions are already in another article, don’t repeat information, hyperlink to the article.
If referencing other parts or features of the platform, hyperlink for more information.
End articles with a hyperlink back to ‘Overview’ article for the category, if applicable.
If an article is an “Overview” of a category, it should include a FAQs section at the end of the article.
FAQ contents should be a numbered list to correspond with numbered subheadings.
If breaking the section into more subsections, include another contents section (not in the callout box) with a bulleted list of hyperlinked headings.
Subsection heading should be heading 2 sized text.
Any “Notes” should be contained in a green ‘Note’ callout box, with “Note:” heading to be in bold and the whole note message to be italics. If the system does not allow the note box in the section you want the note, just have bold “Note:” and whole note message in italics.
Any important information should be contained in a pink ‘Caution’ callout box.
If referencing information outside of Rosterfy, include hyperlinks to external information for references.
Tables should be:
Border: 1px
Style: Solid
Table Width: Percentage (50%)
Cell Padding: 4px
Table Caption: Off
Responsive: On
Top Row: Border: 2px, Bold text, Cell width: 50%, Cell height: 35px
Remaining Rows: Border: 1px
Details:
Fin: Ensure Fin and Copilot are turned on.
Collection: To match the module of the platform or journey of the reader.
Tags: Keywords used in the article, search terms for SEO.
*Title Case Explained: In title case, major words are capitalised and most minor words are lowercase.
Major words include nouns, verbs, adjectives, adverbs, pronouns, and all words of four letters or more.
Minor words include short (i.e., three letters or fewer) conjunctions, short prepositions, and all articles.
In title case, capitalise the following words in a title or heading:
the first word of the title or heading, even if it is a minor word such as “The” or “A”
the first word of a subtitle
the first word after a colon, em dash, or end punctuation in a heading
major words, including the second part of hyphenated major words (e.g., “Self-Report,” not “Self-report”)
words of four letters or more (e.g., “With,” “Between,” “From”)
Use lowercase for minor words that are three letters or fewer in a title or heading (except the first word in a title or subtitle or the first word after a colon, em dash, or end punctuation in a heading):
short conjunctions (e.g., “and,” “as,” “but,” “for,” “if,” “nor,” “or,” “so,” “yet”)
articles (“a,” “an,” “the”)
short prepositions (e.g., “as,” “at,” “by,” “for,” “in,” “of,” “off,” “on,” “per,” “to,” “up,” “via”)