Angela White Johanna Carll Jessica Crouch Sarit Hand
The following is a list of items to take into consideration while building out a Style Guide. Feel free to add notes or make comments on any of it.
Step 1. Layout and format - create a template
Font
style-Sans serif
Font size-12
Font has to be black on white page
Paragraph format
Line spacing
around images - double space
Paragraph - single
Align left, no indent for paragraphs
Line space between paragraphs
Bullets vs numbering
Formatting headings -
Page title - pre defined by Confluence, when page created, it will automatically set the format, Appears to be preset to Heading 1
section titles - Manually formatted, Start with Heading 2, use Heading presets in sequential order for nested sections
Formatting screen shots
Where to place
Before or after a section?
Immediately following the descriptive text? i.e. if we do step by step instructions would we want a screen shot for each step?
Use borderlines around the image to make it more visible - Yes
How much to crop out (if you crop out too much, the image loses context.)
Using arrows to point to specific items on the image? - has to be done outside confluence
Style
Size
color
Step 2. Content structure
Layout
Start each page with a narrative/explain the function?
Followed by step by step instructions in list format?
bullets or numbering
End with use case scenarios? Should we have? If so, how many variations?
Info boxes
Linking to glossary
What needs an entry in the glossary?
How to return from the glossary
How to use abbreviations.
Step 3. Format the style guide to mirror the style guide.
Step 4. Use cases
Video tutorials-Done by another team. Let Jessica know if video tutorial is needed.
Embedded on page or link to?
Should there be a video demo per page to illustrate the text?
Pagination and when to create a new page
Screen shot
Bullets are for lists
Numbering is for step by step instructions
Step 5. Global application
Accessibility
Navigation