Tricky situations
Sometimes no style guide answers a question, or a topic requires some nuance. This page describes a few scenarios.
UI and grammatical conflicts
Sometimes the grammatically correct term conflicts with what is in the UI. When this happens, use the term in the glossary.
- Example
-
The Fusion UI spells datasource as one word. Continue spelling datasource as one word in Fusion. In Springboard, where data source is now two words, write data source as two words.
Who’s the user?
Use you when referring to the user performing the actions in the documentation. You in this context is Lucidworks' customer.
Use the user when referring to other users who have access to the Fusion or Springboard instance but are not the person reading the article. For example, an article about adding users may refer to someone else as the user.
Use the end user when referring to the person viewing the search results or anything a user account is not required to view. The end user may be internal or external. For example, the person searching for shoes on an ecommerce website is the end user.
Include files, configuration schemas, and inconsistent formatting
Sometimes the Docs site includes files or sections of files from other repositories that the Docs team doesn’t control. These files may use formatting that is inconsistent with this style guide.