Naming conventions for guides
Effective guide names use headline-style capitalization, imperative statements, and descriptive verbs or nouns to clearly convey the content's purpose and associated product.
Succinct and descriptive names for guides let a user know what they can expect to find in the content.
Best practices
Follow these best practices when naming a documentation guide:
- Use headline-style capitalization. See Capitalization.
- Use an imperative statement with the product name.
- If the product name is long, you can use an approved product abbreviation at the end of the title. If you're not sure whether an abbreviation is approved, check with the Information Architecture team.
- Use a descriptive verb or noun that conveys the topic type, such as Release Notes, Scenarios, Tutorial, and API Reference.
Guide name examples
The following table shows examples of clear and descriptive guide names:
| A clear, descriptive guide name | What makes this name good |
|---|---|
| Administer Splunk Enterprise Security | This name is a better option than something like "Admin Guide" because it is action-oriented and names the specific product it applies to. |
| Install and Upgrade Splunk Enterprise Security | This name is a better option than something like "Installation Guide" because it lets a reader know that it contains both installation and upgrade content for Splunk Enterprise Security. |
| Get Data Into Splunk User Behavior Analytics | This name is a better option than something like "Getting Data In" because it's imperative in tone for a specific product. |
| Use Splunk Enterprise Security Dashboards | This name is a better option than something like "Dashboard Manual" because it is action-oriented and names the particular product. |
| Integrate the Splunk App for Infrastructure with ITSI | This name is a better option than something like "Integrate SAI" because it tells the reader which products they can integrate. |