Writing style guide

This style guide explains how you should style written content that’s published on pigweed.dev.

Overview

Scope

This style guide applies to all written content that’s published to pigweed.dev.

Other documentation-related style guides

This style guide is narrowly focused on writing conventions such as how to capitalize a document title. See Docs contributors for other aspects of Pigweed’s documentation.

Usage

1. Check if this writing style guide answers your style question.

2. If you don’t find an answer in this guide, check the Google developer documentation style guide (GDDSG). If the GDDSG answers your question, use that answer.

3. If neither this guide nor the GDDSG answers your question, create an issue in the Pigweed tracker. The answer will either get added to this guide or to the GDDSG.

Note

The GDDSG is the “base class” of Pigweed’s writing style. The writing style guide you’re currently looking at is the “derived class” that can override the base class as needed. Overrides must have very strong rationale.

Capitalization

Titles and section headings

Use sentence case. See Capitalization in titles and headings.