
Latest changes to the Splunk Style Guide
This table shows the history of updates to the Splunk Style Guide since its publication on December 2, 2019:
Date | Chapter or topic | Change |
---|---|---|
January 5, 2021 | UI text style guidelines | Added a "Numbers" section with guidance to use numerals in UI text. |
December 3, 2020 | Usage dictionary | Added "multifactor authentication". |
December 3, 2020 | Links to Splunk materials | Updated guidance about linking to subheadings. Now okay to link to an H2 or H3, and treat it the same way as linking to a topic. |
November 30, 2020 | Formatting reference | Changed name of page to "Formatting reference". Added explicit guidance for all elements in documentation rather than generalizations. Added more examples and some sidebar comments. |
November 30, 2020 | Formatting text chapter | Deleted the "Bold", "Italics", and "Monospaced font" topics from chapter. |
November 30, 2020 | Links to third-party websites | Clarified the difference between essential and supplemental links. Added new guidance about linking to essential sites. |
November 30, 2020 | Usage dictionary | Updated formatting in "File paths". Removed guidance that says not to use directional language in UI text. |
November 30, 2020 | Titles and headings chapter | Clarified guidance around how to use heading and text together in "The order of headings" and "Headings and text together" sections. |
November 13, 2020 | Usage dictionary | Added "SSH", "URI, URL", and "URN". |
November 13, 2020 | Measurements | Added tebibyte (TiB). |
November 12, 2020 | Titles and headings chapter | Deleted topics on writing tasks, prerequisites, supertasks, next step sections, and see also sections. Changed "Content structure" chapter name to "Titles and headings". |
November 11, 2020 | Formatting quick reference | Added formatting guidance for URIs and URLs. |
November 9, 2020 | Usage dictionary | Update definitions for "ad hoc", "drilldown", and "lookup". Added "app". Added examples to "command-line" and "real-time". |
July 22, 2020 | Usage dictionary | Updated "master" and "install". Added "slave" and "deploy". |
July 20, 2020 | Usage dictionary | Updated "blacklist" and "whitelist". |
May 26, 2020 | Usage dictionary | Added "AM" and "PM". |
May 22, 2020 | Usage dictionary | Clarified guidance for "*nix*, "Linux", and "UNIX". |
May 22, 2020 | Usage dictionary | Added "blacklist" and "whitelist". |
April 13, 2020 | Usage dictionary | Added "into". Also added a correct usage example to the Manual names, topic titles, and section headings topic. |
April 13, 2020 | Usage dictionary | Added "reenable" and revised the entry for "reenter". |
March 24, 2020 | Usage dictionary | Clarified "multivalue field". Updated "plugin" as a noun or adjective. |
March 19, 2020 | Example names and domains | Updated IP address blocks to be ranges. |
March 9, 2020 | Numbers or numerals? | Added guidance around duration of time. |
March 5, 2020 | Write in indicative or imperative mood | Updated title and guidance to emphasize writing in indicative and imperative mood and to avoid writing in subjunctive mood. Added new examples. |
February 19, 2020 | Usage dictionary | Added "spin up, spin down". |
February 18, 2020 | Formatting quick reference | Clarified language and examples for square brackets around .conf file stanza names. |
February 5, 2020 | Usage dictionary | Added "directory". |
January 31, 2020 | Usage dictionary | Added "drilldown" as an adjective. |
December 23, 2019 | Usage dictionary | Added "tarball". |
December 12, 2019 | Commas and decimals | Added clarification to use standard American-style formatting for commas and decimal points in numbers. |
Last modified on 05 January, 2021
PREVIOUS Welcome to the Splunk Style Guide |
NEXT A word about Splunk docs |
This documentation applies to the following versions of Splunk® Style Guide: current, current
Feedback submitted, thanks!