mirror of
https://github.com/fleetdm/fleet
synced 2026-05-06 06:48:54 +00:00
Format headings for consistency in communications.md (#35569)
This commit is contained in:
parent
f7a6897003
commit
328ea9ba8f
1 changed files with 2 additions and 2 deletions
|
|
@ -1090,12 +1090,12 @@ Headings and titles should:
|
|||
|
||||
##### Static headings
|
||||
|
||||
Use static headings (a `noun` or `noun phrase`) e.g., “Log destinations,” for concept or reference topics. Be as short and specific as possible.
|
||||
Use static headings (a `noun` or `noun phrase`) e.g., _“Log destinations,”_ for concept or reference topics. Be as short and specific as possible.
|
||||
|
||||
|
||||
##### Task-based headings
|
||||
|
||||
Use task-based headings (`verb` + `topic`) e.g., _“Configure a log destination”_ for guides and tutorials where the heading should reveal the task that the reader is trying to achieve.
|
||||
Use task-based headings (`verb` + `topic`) e.g., _“Configure a log destination,”_ for guides and tutorials where the heading should reveal the task that the reader is trying to achieve.
|
||||
|
||||
|
||||
##### Avoid _-ing_ verb forms in headings
|
||||
|
|
|
|||
Loading…
Reference in a new issue