Skip to content

writing-style-guide: add headings style guidance #3072

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
franrob-projects merged 1 commit into from
Jan 5, 2026
Merged

writing-style-guide: add headings style guidance #3072

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions writing-style-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,21 @@ There are some exceptions: for example, the names of products, the titles of sta

So, unless there is a good reason not to, use sentence case (first letter is capitalized).

## Heading forms

Use imperative form for headings.

The imperative form is direct and action-oriented, making it clear what the developer needs to do.

Examples:

* *Imperative (preferred):* Configure the API client
* *Gerund (avoid):* Configuring the API client
* *Imperative (preferred):* Install the SDK
* *Gerund (avoid):* Installing the SDK

The only exception is FAQ-style content where the heading is phrased as a question. In all other cases, use the imperative form.

## Bulleted lists

This is an example of a bulleted list:
Expand Down