[SAMPLE -- This is a sample template for providing style/structure guidance. See Create from template on creating articles using templates.]
Use this template just to get quick and easy styles/structures for any article. Below is a sample of styles and what we use them for.
Heading 2: Major topic
Body paragraph. Anything not in a list should be formatted like this. References to specific menu/navigation options should be capitalized, e.g.: Click on Settings > Style. In general, avoid using italics. Use bold only when it feels necessary.
Heading 3: Subheading for Heading 2
Heading 4: You should really consider restructuring your content and breaking it up
- Always use numbered lists for step-by-step instructions.
- Step 1. Each step should be a single, clear step in the process.
- Screenshots should be included in the list item so that they are properly indented. Include arrows or callouts using branded color palette. Use rounded square for shape call-outs.
- Sample code should be included in the list item so that it is properly indented:
<a href="#">Here's some sample code in just preformatted style</a>
Bullet point lists:
- Always use bullet point lists for lists rather than instructions
- Point Number 2
- Good use of bold: when you have a bullet point list with items that also have descriptions
- Keep your list consistent; list items should either all end in periods or should have no periods
- Screenshots relevant to the list should be within the bulleted list item:
Pro Tip: Use Alert Success for things that could be classified as tips or "Pro Tips". These look better if they start with a bolded phrase.
Note: Use Alert Info for useful notes and asides. These aren't tips; they're a note or point that you want to call attention to.
Warning: Use Alert Danger for things that are destructive, permanent, or otherwise dangerous. If making a change or not following this step is going to cause disaster and chaos, tell people!