Titles & Headings
Write titles using “Title Case”.
Use headings (makes to break up content.
Both make it easier to link to a section in an article)add links and optimise for searches
Description
Describe what a function is for and why they would use it (unless obvious to the simplest end userthe problem the article addresses.
Can include an example use case where the where the problem/process might occur.
State which users article is for (if applicable)
Location
Describe or show how to get to the function from the homepage
...
Will be added later in Zendesk
Underline where links should go for easy ID during transition.
Article Content
Use Screenshots or GIFs if something isn’t obvious from the screen.
...
If an article is around 2+ pages long (and can’t be separated) please include a “jump to” index of headings with for hyperlinks near at the top of the page, after the description.
Marking Up
When reviewing/editing articles that weren’t assigned to ‘YOU’, please either:
Make comments proposing change/clarity? (For important/major changes)
Markup/change the content, but then make the colour reflect as:
Lauren = Orange
Dwain = Green
David = Yellow
Tim = Blue
Sean = Purple