1.. _docs-pw-style-writing: 2 3=================== 4Writing style guide 5=================== 6.. inclusive-language: disable 7.. _reStructuredText: https://en.wikipedia.org/wiki/ReStructuredText 8.. _Sphinx: https://www.sphinx-doc.org/en/master/ 9.. inclusive-language: enable 10 11This style guide explains how you should style written content that's published 12on ``pigweed.dev``. 13 14.. _docs-pw-style-writing-overview: 15 16-------- 17Overview 18-------- 19 20.. _docs-pw-style-writing-scope: 21 22Scope 23===== 24This style guide applies to all written content that's published to 25``pigweed.dev``. 26 27.. _docs-pw-style-writing-other: 28 29Other documentation-related style guides 30======================================== 31This style guide is narrowly focused on writing conventions such as how to 32capitalize a document title. See :ref:`docs-contrib-docs` for other aspects 33of Pigweed's documentation. 34 35.. _docs-pw-style-writing-usage: 36 37Usage 38===== 39.. _Google developer documentation style guide: https://developers.google.com/style 40.. _create an issue: https://pwbug.dev 41 421. Check if this writing style guide answers your style question. 432. If you don't find an answer in this guide, check the 44 `Google developer documentation style guide`_ (GDDSG). If the GDDSG answers 45 your question, use that answer. 463. If neither this guide nor the GDDSG answers your question, `create an issue`_ 47 in the Pigweed tracker. The answer will either get added to this guide or to 48 the GDDSG. 49 50.. note:: 51 52 The GDDSG is the "base class" of Pigweed's writing style. The writing style 53 guide you're currently looking at is the "derived class" that can override 54 the base class as needed. Overrides must have very strong rationale. 55 56.. _docs-pw-style-writing-caps: 57 58-------------- 59Capitalization 60-------------- 61 62.. _docs-pw-style-writing-caps-headings: 63 64Titles and section headings 65=========================== 66.. _Capitalization in titles and headings: https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings 67 68Use sentence case. See `Capitalization in titles and headings`_. 69