search

thegooddocsproject / templates

Templates created by The Good Docs Project - for all your tech writing needs.
https://thegooddocsproject.dev/
Other
677 stars 170 forks source link

Update "Before you Start" #90

Open camerons opened 4 years ago

camerons commented 4 years ago

doc: https://github.com/thegooddocsproject/templates/blob/master/how-to/about-howto.md

Have you ever got half-way through a how-to, only to discover you need to go and read other documentation before you can continue? This section is designed to prevent this from happening in the first place.

Felicity Brand 13:39 14 Nov Pre-reqs aren't always about going to read something else. Sometimes they are just about dependencies like "you need an internet connection".

Describe what the audience needs to know, or needs to have, before attempting this how-to. By stating the requirements up-front, you prevent your audience from having a bad experience with your tutorial.

Felicity Brand 13:40 14 Nov And give them useful pointers about how to get whatever they need. Link to procedures or info.

Make sure you meet the following pre-requisites before following the steps:

Louise Brooks 14:21 14 Nov prerequisites doesn't have a hyphen

  • API credentials for the {company} v3.5 API. Refer to creating your API credentials

Felicity Brand 13:40 14 Nov Add: “Refer to creating your API credentials ”

  • An understanding about what a RESTful API is conceptually

Felicity Brand 13:41 14 Nov Add: “Read about the RESTful API ” Louise Brooks 14:24 14 Nov or embed the link into the sentence... An understanding about the concept of a ...

  • API credentials for the {company} v3.5 API. Refer to creating your API credentials
  • Access to the Postman application.
  • An understanding about what a RESTful API is conceptually. Read about the RESTful API
  • (Optional) A development tool (IDE) that displays API responses formatted for readability.

Felicity Brand 13:42 14 Nov Add: “You need to have a list of Favorites before you can manage them. Refer to “Create Favourites” for mo…” Louise Brooks 14:25 14 Nov favourites? (spelling)

jahnvigupta commented 4 years ago

@camerons can i take this issue?

jaredmorgs commented 4 years ago

Feel free to get me to review it @jahnvigupta

camerons commented 4 years ago

Thanks for the offer to help @jahnvigupta. You are welcome to create a pull request to fix any of the issues.

jahnvigupta commented 4 years ago

@jaredmorgs I have opened a PR. Kindly, check https://github.com/thegooddocsproject/templates/pull/127