Couchbase Documentation Style Guide
One of my first major tasks at Couchbase was creating a style guide, to try and get the 10+ person writing team working with greater consistency.
The first iteration of the style guide was posted on my work GitHub account. I created the theme based on the default Antora site theme, adding in some Couchbase styling and elements from the main documentation site.
You can find that initial version of the style guide at https://sarahlwelton.github.io/cb-vale-style-guide/styleguide/index.html.
After some management changeover and a little more of a serious talk about the importance of the style guide, we incorporated the style guide into our contributor’s guide on the main documentation website: https://docs.couchbase.com/styleguide/index.html.
There are 2 other style guides that I tried to create to guide efforts when the documentation team’s mandate was larger, and included Pendo and UI copy. You can still view those on the site.
Vale Style Guide
The Couchbase Style Guide also has a Vale implementation, which you can see here: https://github.com/couchbaselabs/docs-style-guide.
I figured out all of the configuration, and have written most of the Vale rules myself, to catch common issues that contradict the style guidance from the style guide, or just common mistakes.