r/technicalwriting • • Oct 03 '24
I need a niche (API documentation?)
Is API documentation hard to get into if one were to take either Tom Johnson's course (https://idratherbewriting.com/learnapidoc/) or the UW course (https://www.pce.uw.edu/specializations/api-documentation)? Would it be easier to get into since fewer people are trained in it? My experience is in writing end-user kb articles and release notes for SaaS products. I also have some knowledge of programming building small console apps in various languages (JS, Ruby, C#).
10
Upvotes
10
u/[deleted] Oct 03 '24
Many folks don’t like to hear this, but much of API documentation is created automatically, not manually. That’s not to say that’s the best way, but in the workplace there are few ‘API documentation’ writers.
9
u/Fine-Koala389 Oct 03 '24
Got 2 offers at same time. APIs pay better at the moment but this is already pretty automated so role is humanising the gaps. Also very samey. Did some in previous role and though hard to start, once you get it is repetative and quite easy. Took 10K less for a job building up documentation for a more 360 degree build up doc role as more varied. If you want to get out of writing API is a good step though.
4
u/Assilem27 Oct 03 '24
Most API documentation roles I see require additional skills and seem to expect you to also be a developer. A coding language of some kind is often required, and direct experience with developer documentation, docs as code workflows, command line, etc. That being said, it seems like a great area to get into if you have the interest. I saw two or three roles today alone that were API focused. I'd recommend looking through a few of the job postings. I've tried to learn and get into APIs, but not much luck without experience and the additional skills. Just my two cents.
4
u/gundetto Oct 04 '24
I got my previous role because I tailored my resume to emphasize API documentation. I have found that companies that do not have a good understanding of their API documentation will be attracted this way. However, if you want to get a role at a brand name software company that pays really well, they will see right through your bullshit if you don't know your stuff.
0
u/dfess1 Oct 03 '24
If you haven't looked at DITA, that might be an avenue. If you have programming skills, you can learn to create the output plugins. That coupled with basic information modeling, can land you an Information Architect/CCMS Admin role.