Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Commit

Permalink
Reword intro to Api Overview to flow better
Browse files Browse the repository at this point in the history
Not sure if this is too dramatic. This is an attempt to address Issue #34, i.e. that "document set" was a bit unnatural. 

Decided to give a short sharp answer in the beginning, and tack on that initial sentence to the end of this section, which felt more natural as the preceding sentences explained the why behind it nicely.
  • Loading branch information
Francesco-Lanciana committed Jan 17, 2020
1 parent 4d9e0d9 commit 978aef5
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions api-overview/about-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@

### When Do I Need an Overview?

Every document set should include an overview. This document tells potential users or buyers of the product the things they might want to know before adoption.
Always.

This document tells potential users or buyers of the product the things they might want to know before adoption.

Many users install or plug into your service immediately because they are already familiar with it or someone else has decided that the team will use this solution. All of those people will go to your Quickstart, or will just get to work.

There are other groups, however, who need to assess your product in order to decide whether they want to use it. They are either the managers responsible for a business decision, or they are engineers who don't know enough about your product to decide whether it can accomplish what they want it to do. People who fall in either of these groups might decide not adopt your product unless you provide an overview that answers their questions.
There are other groups, however, who need to assess your product in order to decide whether they want to use it. They are either the managers responsible for a business decision, or they are engineers who don't know enough about your product to decide whether it can accomplish what they want it to do. People who fall in either of these groups might decide to not adopt your product unless you provide an overview that answers their questions. As such your API documentation should always include an overview document.

## Content of Your Overview

Expand Down

0 comments on commit 978aef5

Please sign in to comment.