Titles
Write titles using “Title Case”
Use headings (makes it easier to link to a section in an article)
Description
Describe what a function is for and why they would use it (unless obvious to the simplest end user)
Location
Describe or show how to get to the function from the homepage
Links
Will be added later in Zendesk
Article Content
Use Screenshots if something isn’t obvious from the screen.
Spread things out, avoid a large block of text.
If the same process is likely to appear in several articles, put it in a separate article and link to it from all of those articles.
Article Length
If an article is around 2+ pages long (and can’t be separated) please include a “jump to” index of headings with hyperlinks near the top of the page.
Marking Up
When reviewing/editing articles that weren’t assigned to ‘YOU’, please either:
Make comments proposing change/clarity?
Markup/change the content, but then make the colour reflect as:
Lauren = Orange
Dwain = Green
David = Yellow
Tim = Blue
Sean = Purple