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

About

This is our in-house style guide, written to make our writing style, our structure and our content consistent. It contains specific guidelines for structuring external-facing customer documentation, as well as our other writing, whether it’s for an external or internal audience, and whether it’s technical documentation, blog posts, guest posts or social media posts.

This style guide is based on the following which we acknowledge with thanks.

It is a sister guide to our in-house technical component library which similarly constrains our approach to solving technical user interface problems.

Work in progress

We have written a lot of content over the years, and some of it will not adhere to this newer guide. Editing our past work is a work in progress: thank you for your patience in the meantime when you spot inconsistencies between what’s published, and what’s in the style guide.

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