OpenSearch style guidelines are now available

Wed, Jun 29, 2022 · Nathan Bower

The OpenSearch team is excited to announce the release of the style guidelines for our documentation and marketing content! These guidelines cover the style standards and terms to be observed when creating OpenSearch content. Our growing team of technical writers and editors is committed to providing complete and best-in-class documentation to the OpenSearch community, and releasing our style guidelines reflects this commitment.

Included in the style guidelines is guidance on voice and tone, punctuation and capitalization, numbers and measurement, formatting and organization, special considerations for blog posts, inclusive content, and more. We have also provided a list of terms to be observed in OpenSearch content. These resources will evolve as we implement best practices and lessons learned from working with you, the community.

As part of our focus on producing exceptional content, we are developing quality assurance processes, resources, and initiatives to help us standardize our approach to creating bar-raising OpenSearch content. Our style guidelines represent one of the mechanisms our team will use to achieve this. Check out the style guidelines, and feel free to let us know what you think.

OpenSearch values transparency, and we welcome community contributions to our style guidelines. To access our documentation, see the OpenSearch documentation home page. If you want to contribute to the OpenSearch documentation, see the file, which covers how to open an issue or create a pull request on GitHub. We look forward to collaborating with you!