Skip to content

Commit

Permalink
Add info about API intros
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanpalm authored Jun 16, 2021
1 parent c1da8e0 commit ff7ffdd
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions contributing/content-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -355,6 +355,8 @@ The top of every page has an intro that provides context and sets expectations,
#### How to write an intro
- Article intros are one to two sentences long.
- Map topic and category intros are one sentence long.
- API reference intros are one sentence long.
- The intro for an API page should define the feature so that a user knows whether the feature meets their needs without reading the entire article.
- Intros contain a high-level summary of the page’s content, developing the idea presented in a title with more detail.
- Use approachable synonyms of words in the page’s title to help readers understand the article’s purpose differently. Avoid repeating words from the title when possible.
- Intros are relatively evergreen and high-level, so they can scale with future changes to the content on the page without needing to be frequently updated.
Expand Down

0 comments on commit ff7ffdd

Please sign in to comment.