Writing

    Principles

  1. Accessible content

  2. Style and tone

  3. General guidelines

  4. Link text

  5. Formatting

  6. UI elements

  7. Language

  8. Attribution

  9. File names

  10. Punctuation

  11. Task-specific guidelines

  12. In-depth articles

  13. File structure

  14. How-to documentation

  15. Images

    Image optimisation

  16. Image optimisation

  17. Logos

  18. Logos

  19. Colour

    Accessible colours

  20. Accessible colours

  21. Typography

    Fonts

  22. Fonts

One tag per article

Refer to the list of tags for documentation articles in application_helper.rb

Find the list of tags for blog posts on the blog post page.

Excerpt

Each article should start with motivational text at the top. The excerpt should summarise what the article is about, and what the reader will learn. Do not put a full stop at the end of the excerpt.

Headings

The title of every article uses an h1 heading; article sections use h2 headings; subsections use h3 headings; etc.

Headings are favoured by our search engine, Algolia. Think about how users will search for the topic and include those phrases in the headings in particular.

When writing headings, capitalise the first word only.

Helpers

Use the translations in locale.yml and helpers in helpers/application_helper.rb wherever possible for consistency and easy maintenance, and feel free to add more

Schedule a call to see Consonance in action and discuss your own situation. If you have your data in the ONIX format, send it over and we'll import it, to make the call particularly interesting.

Contact us