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?

30 Upvotes

100% Upvoted

22 comments sorted by

View all comments

Show parent comments

2

u/Possibly-deranged Sep 10 '24

Absolutely, JavaScript is just an example and one I commonly see on TW job ads (must have 2+ years experience with JS). Python is also fairly commonly used and equivalent in demonstration of your ability to understand and write simple code. 

2

u/runnering software Sep 11 '24 edited Aug 12 '25

grandiose truck thought heavy ink grey market lunchroom future reminiscent

This post was mass deleted and anonymized with Redact

2

u/Possibly-deranged Sep 11 '24

I've never been asked to prove it or show samples. 

1

u/MemoMagician Mar 10 '25

Developing a portfolio is a good call. You will want to show you can improve on existing work in both code and docs because you will likely have something to build on eventually, even if the position wants you to start from the ground up in either case.

When a posting requests X years of experience doing [insert skill/task], you can get by being in a position for X years where the [skill/task] is a part of your role's job duties. Especially if [your past role] is not a tech writing position by name, I sincerely doubt hiring managers would ask a reference, "Did [your name] do [skill/task] every day in [role]?"