Lucidworks style guide
The Lucidworks Docs team style guide provides guidance for writing clear and consistent documentation. It provides a starting point for all Docs team members to ensure our documentation looks and sounds alike across the site. All Docs team members should abide by the style guide.
Unite Lucidworks by standardizing voice, tone, and style to create a consistent user experience.
Resources
For situations not covered by this style guide, consult the following resources:
| Resource | Description |
|---|---|
Google Developer Documentation Style Guide (GDDSG or GDG) |
The official technical style guide of the Lucidworks Docs team. Many articles in the Lucidworks style guide link back to a relevant Google Developer Documentation Style Guide article instead of reproducing entire pages. Exceptions to the GDDSG are called out in this style guide. |
Consult The Chicago Manual of Style for general grammatical questions not covered in the Google Developer Documentation Style Guide. A subscription is required. |
|
Merriam-Webster.com (M-W) |
Consult the Merriam-Webster online dictionary for general spelling guidance. Consult the glossary and the Google Developer Documentation Style Guide first when confirming the spelling of technical terms. Some words have multiple correct spellings; if this occurs either spelling is acceptable. |
Depart from the rule if doing so makes your documentation better. If ignoring a rule consistently makes your documentation better, consider requesting a change to the style guide when submissions open. Additionally, if you refer to the Google Developer Documentation Style Guide on a specific topic regularly and find that a specific section on this style guide needs more clarification or content, consider requesting an addition to that section.
Public feedback
The Docs team accepts feedback from Lucidworks employees and the general public. Click Feedback on any page to submit your feedback.