Writing guide

Resources to help write in style

Why write in style

Whether it’s SQL Prompt or SQL Compare, SQL Source Control or one of the many other tools in the Redgate portfolio, our products are used by a diverse community of developers across the globe.

Thanks to our design system, Honeycomb, they offer a coherent user experience that looks easy, feels easy, and actually is easy. Once you’ve used one tool, the others will be familiar. They all shout Redgate. Well, they whisper it.

Honeycomb also applies to the language we use. Whatever product we develop, documentation we write, or content we create, the words and phrases need to be consistent. Consistency brings clarity, not confusion, and makes the task of writing about Redgate products and within Redgate products easier too.

That’s what this guide is about. Divided into bite-size sections, it gives you advice on everything from how we write inside applications to the correct format for release notes and the style we prefer for the Redgate website.

We’ve also included a Usage Dictionary as a handy reference source for those odd-to-spell words and grammatical conundrums you might wonder about. If you’re not sure how to spell or phrase something, the answer’s probably here. If not, refer to the Merriam Webster dictionary (we use American spelling and it’s the best source we’ve found).

If we’ve missed something, talk to a Tech Comms coach about software documentation, or Marketing about content.

Applications

How to write for applications consistently and with clarity

Read the guide

Usage dictionary

General advice on the ways we use and spell certain words

See dictionary