Skip to content

Commit

Permalink
fixing typos
Browse files Browse the repository at this point in the history
  • Loading branch information
tomjoht committed Dec 25, 2018
1 parent 3e1fb02 commit 371083c
Show file tree
Hide file tree
Showing 11 changed files with 90 additions and 92 deletions.
4 changes: 2 additions & 2 deletions _data/docapis.yml
Expand Up @@ -172,7 +172,7 @@ folders:
description: "Testing your documentation is critical to providing accurate, thorough information. With API and developer docs, due to the high level of complexity and engineering requirements, technical writers might be inclined to simply take information that engineers give them and incorporate them wholesale, without personally testing them. Merely playing an editorial can reduce your role to that of an engineer's secretary."
folderitems:

- title: Overview to testing your docs
- title: Overview of testing your docs
jurl: /testingdocs_overview.html

- title: Set up a test environment
Expand Down Expand Up @@ -337,7 +337,7 @@ folders:
- title: REST API exercises
jurl: /docapis_more_rest_exercises.html

- title: "Activity: Get event information using the EventBrite API"
- title: "Activity: Get event information using the Eventbrite API"
jurl: /docapis_eventbrite_example.html

- title: "Activity: Retrieve a gallery using the Flickr API"
Expand Down

Large diffs are not rendered by default.

Expand Up @@ -39,7 +39,7 @@ Put a link to your Getting Started tutorial on your documentation homepage. Make

## Run in Postman button {#runinpostmanbutton}

In your Getting Started tutorial, consider including a Run in Postman button. (Postman is a REST API GUI client that we explored earlier in [Submit requests through Postman](docapis_postman.html).) If you have your [API endpoints integrated in Postman](docapis_postman.html), you can export your Postman collections as a widget to embed in an HTML page.
In your Getting Started tutorial, consider including a Run in Postman button. (Postman is a REST API GUI client that we explored earlier in [Submit requests through Postman](docapis_postman.html).) If you have your [API endpoints integrated with Postman](docapis_postman.html), you can export your Postman collections as a widget to embed in an HTML page.

The [Run in Postman button](https://www.getpostman.com/integrations/run-button) provides a button that, when clicked, imports your API info into Postman so users can run calls using the Postman client. As such, the Run in Postman button provides a way to import the interactive, try-it-out API explorer for your endpoints into a web page.

Expand Down Expand Up @@ -75,7 +75,7 @@ When you click the button, you should be prompted to open the collection in a Po

{% include course_image.html size="small" filename="postmanlaunchhandler" ext_print="png" ext_web="png" alt="Options to open the Postman collection" caption="Options to open the Postman collection" %}

[Postman](docapis_postman.html) provides a powerful REST API client that many developers are familiar with. It allows users to customize the API key and parameters and save those values. Although Postman doesn't provide the in-browser experience to try out calls as with [Swagger UI](pubapis_swagger_demo.html), in many ways the Postman client is more useful, because it lets users configure and save the calls they make. This is what internal developers often use to save and store API calls as they test and explore the functionality.
[Postman](docapis_postman.html) provides a powerful REST API client that many developers are familiar with. It allows users to customize the API key and parameters and save those values. Although Postman doesn't provide the in-browser experience to try out calls as with [Swagger UI](pubapis_swagger_demo.html), in many ways the Postman client is more useful because it lets users configure and save the calls they make. Postman is what internal developers often use to save and store API calls as they test and explore the functionality.

{% include random_ad2.html %}

Expand All @@ -87,13 +87,13 @@ The downside is that your parameter and endpoint descriptions don't get pulled i

## Samples of API overviews

Here are a few sample Getting Started topics in APIs. If you compare the various Getting Started sections, you'll see that some are detailed and some are high-level and brief. In general, the more you can hold the developer's hand, the better. However, the tutorial should still be brief and not simply redundant with the other documentation. The key is that you show the user the beginning-to-end, full process in working with the API.
Here are a few sample Getting Started topics in APIs. If you compare the various Getting Started sections, you'll see that some are detailed and some are high-level and brief. In general, the more you can hold the developer's hand, the better. However, the tutorial should still be brief and not simply redundant with the other documentation. The key is that you show the user the beginning-to-end, full process for working with the API.

### Paypal

{% include course_image.html url="https://developer.paypal.com/docs/api/overview/" filename="paypalgetstarted" ext_print="png" ext_web="png" alt="Paypal getting started tutorial" caption="Paypal getting started tutorial" %}

Paypal's getting started tutorial contains quite a bit of detail, starting out with authorization, requests, and other details before making the first call. Although not so brief, this level of details helps orient users with the information they need. The format is clean and easy to follow.
Paypal's getting started tutorial contains quite a bit of detail, starting with authorization, requests, and other details before making the first call. Although not so brief, this level of details helps orient users with the information they need. The format is clean and easy to follow.

### Twitter

Expand All @@ -105,7 +105,7 @@ Twitter's getting started page has several getting started sections for differen

{% include course_image.html url="http://docs.parseplatform.org/parse-server/guide/#getting-started" filename="parseservergettingstarted" ext_web="png" ext_print="png" alt="Parse Server getting started" caption="Parse Server getting started" %}

The Parse Server tutorial provides a good amount of detail and handholding through the various steps. For the more detailed steps on connecting your app and running the server elsewhere, the tutorial links out to more information.
The Parse Server tutorial provides a fair amount of detail and handholding through the various steps. For the more detailed steps on connecting your app and running the server elsewhere, the tutorial links out to more information.

### Adsense

Expand All @@ -123,7 +123,7 @@ The Aeris weather getting started provides information for setting up an applica

{% include course_image.html url="https://console.bluemix.net/docs/services/watson/index.html#about" filename="watsongettingstarted" ext_print="png" ext_web="png" alt="Watson and IBM Cloud getting started tutorial" caption="Watson and IBM Cloud getting started tutorial" %}

The Watson and IBM Cloud getting started tutorial lists 3 steps. It's not an end-to-end getting started tutorial, though. It just gets the user started in selecting a service for your project. At the end, you start to code using the Watson Dashboard. Ideally, a getting started tutorial should help a user see some tangible output, but whether that's possible or not depends on your API.
The Watson and IBM Cloud getting started tutorial lists three steps. It's not an end-to-end getting started tutorial, though. It just gets the user started in selecting a service for your project. At the end, you start to code using the Watson Dashboard. Ideally, a getting started tutorial should help a user see some tangible output, but whether that's possible or not depends on your API.

{% include random_ad.html %}

Expand Down
12 changes: 6 additions & 6 deletions _docs/documenting_nonreference_content/docapis_doc_overview.md
Expand Up @@ -20,7 +20,7 @@ The API overview explains what you can do with the API, including the high-level

Too often with API documentation (perhaps because the content is often written by developers), the documentation gets quickly mired in technical details without ever explaining clearly what the API is used for. Don't lose sight of the overall purpose and business goals of your API by getting lost in the endpoints.

The API overview grounds users with a high-level understanding of the system. This high-level understanding is critical to grasping the system as a whole. It allows the details to fit into a larger conceptual framework.
The API overview grounds users with a high-level understanding of the system. This high-level understanding is critical in order to grasp the system as a whole. It allows the details to fit into a broader conceptual framework.

To get an idea of what the API is about, users start at a high-level, getting a gist of what something is about from the title and description, and then work their way into more details. This overview provides this initial orientation for the user.

Expand All @@ -29,7 +29,7 @@ To get an idea of what the API is about, users start at a high-level, getting a
{: .tip}
For more details on the importance of high-level overviews, see [Reduction, layering, and distillation as a strategy for simplicity](https://idratherbewriting.com/simplifying-complexity/reduction-layering-distillation.html).

In the overview, list some common business scenarios in which the API might be useful. This will give users the context they need to evaluate whether the API is relevant to their needs.
In the overview, list some common business scenarios in which the API might be useful. These scenarios will give users the context they need to evaluate whether the API is relevant to their needs.

{% include random_ad.html %}

Expand All @@ -43,7 +43,7 @@ In [The Top 20 Reasons Startups Fail](https://www.cbinsights.com/research/startu
This overview focuses in on the market problem that the API solves. If your API fails, it's likely because it's not solving a market problem.

The API overview usually appears on the homepage of the API. The homepage (the start of your docs) is a good place to put this overview, because in this overview you also define your audience. Understanding your audience helps you orient the content in your API documentation appropriately.
The API overview usually appears on the homepage of the API. The homepage (the start of your docs) is a good place to put this overview because in this overview you also define your audience. Understanding your audience helps you orient the content in your API documentation appropriately.

## Sample API overviews

Expand All @@ -53,19 +53,19 @@ Here are a few sample API overviews.

{% include course_image.html url="https://sendgrid.com/docs/User_Guide/index.html" filename="sendgridoverview" ext_web="png" ext_print="png" alt="SendGrid API overview" caption="SendGrid API overview" %}

The Sendgrid overview starts off with two key sections: "What is SendGrid?" and "Who is SendGrid for?" I like the straightforward approach. Even in the description of what SendGrid is, the authors don't assume everyone knows what an SMTP provider is, so they link out to more information. Overall, in about 10 seconds you can get an idea of what the SendGrid API is all about.
The Sendgrid overview starts with two key sections: "What is SendGrid?" and "Who is SendGrid for?" I like the straightforward approach. Even in the description of what SendGrid is, the authors don't assume everyone knows what an SMTP provider is, so they link out to more information. Overall, in about 10 seconds you can get an idea of what the SendGrid API is all about.

### Lyft

{% include course_image.html url="https://developer.lyft.com/docs/overview" filename="lyftapioverview" ext_web="png" ext_print="png" alt="Lyft API overview" caption="Lyft API overview" %}

Lyft's API overview starts out in a similar way, with sections titled "What is Lyft?" and "Why Use Lyft as a Developer." Their homepage also provides information on access, rate limits and throttling, and testing. The Lyft authors also recognize that each tech domain has its own lingo, so they provide a [glossary](docapis_glossary_section.html) up front.
Lyft's API overview starts in a similar way, with sections titled "What is Lyft?" and "Why Use Lyft as a Developer." Their homepage also provides information on access, rate limits and throttling, and testing. The Lyft authors also recognize that each tech domain has its own lingo, so they provide a [glossary](docapis_glossary_section.html) up front.

### IBM Watson Assistant

{% include course_image.html url="https://console.bluemix.net/docs/services/conversation/index.html#about" filename="ibmcloudoverview" ext_web="png" ext_print="png" alt="IBM Watson Assistant overview" caption="IBM Watson Assistant overview" %}

IBM Watson Assistant starts off with a brief summary of the service, followed by a high-level diagram of the system and a summary about how to implement it. Including a diagram of how your API works gives users a good grounding about what to expect, such as the level of complexity and time it will take to incorporate the API.
IBM Watson Assistant starts off with a brief summary of the service, followed by a high-level diagram of the system and a summary about how to implement it. Including a diagram of your API gives users a good grounding about what to expect, such as the level of complexity and time it will take to incorporate the API.


## <i class="fa fa-user-circle"></i> Activity with API overviews
Expand Down

0 comments on commit 371083c

Please sign in to comment.