Skip to content

Commit

Permalink
clarify how-to titls (Kong#1758)
Browse files Browse the repository at this point in the history
  • Loading branch information
Aron Eidelman authored Feb 3, 2020
1 parent d9aa81a commit 3e2cfb8
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions TECHNICAL-WRITING-GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,7 @@ a specific concept.

### How-to Guides

How-to guides should solve an explicit problem or accomplish a specific task
such as “How to Delete an Admin”
How-to guides should solve an explicit problem or accomplish a specific task.

They should follow the following structure:

Expand All @@ -123,7 +122,8 @@ a starting point.

*Title [h1]*

How-to guide titles typically follow the “How to [X] using [Y]” format.
How-to guide titles typically follow the “[imperative verb] + [object] + [details]” format, e.g.,
"Delete an Admin," "Install Kong on Amazon Linux"

*Table of Contents [h4]*

Expand Down

0 comments on commit 3e2cfb8

Please sign in to comment.