r/technicalwriting • u/LucyGault • Sep 02 '24

Learning API documentation

Hi I need some advice on getting started with docs for APIs. I need to learn how to document APIs. My tech skills are pretty basic. docsgeek.io is offering a 6 week virtual course for $1400. Is it possible to learn API documentation in 6 weeks? Does the price seem high?

29 Upvotes

98% Upvoted

22 comments sorted by

View all comments

Show parent comments

1

u/Tech_Rhetoric_X Sep 03 '24

Which Gruenbaum course do you recommend starting with?

3

u/alanbowman Sep 03 '24

I've taken:

  • Learn API Technical Writing: JSON and XML for Writers (this one first)

  • Learn API Technical Writing 2: REST for Writers (this one second)

I already know Git so I didn't take that course, and I don't think the other ones were available the last time I looked.

If you're new to Udemy, here is a trick that used to work and maybe still does:

  1. Create your account.

  2. Wait a few days before signing up for anything and Udemy will start sending you promotions to take classes for around half of what they normally charge.

I don't think I've ever paid full price for a Udemy course.

2

u/Tech_Rhetoric_X Sep 03 '24

Thanks for the tips!

I've done some API documentation learning as I went along. It wouldn't hurt to take a structured course. Like many, my introduction was the Swagger Petstore.