top of page

Developer Documentation and API Documentation

I have been studying Developer and API documentation throughout my Technical Writing program at Portland State University. I did this by giving myself a developer-bootcamp-style experience.

 

In addition to some front end web development basics, I taught myself:

  • JavaScript 

  • Git and GitHub

  • GitHub Pages and Jekyll 

  • Markdown

  • HTTP Essentials

  • How to launch an open source project

 

Furthermore, I am currently taking a web developer bootcamp course, "The Complete Web Developer Zero to Mastery," so that I can more fully understand how developers think.

To supplement my learning, I have interned with a local web development shop, Flight.run, for several terms in a row as a content marketer so that I could watch and learn the workflow of developers. I have also volunteered with Code For PDX, a volunteer group that builds apps for nonprofits in Portland where I learned about using Twitter's API and about, developer documentation, and being part of a user experience team. I came out of these experiences more confident in my ability to work with developers using a docs-like-code approach and my ability to be a productive contributor to any software development team.

My Spring 2019 Internship:

This Spring term, I have begun an internship with IdRatherBeWriting.com. I am helping them edit and expand the site's API documentation course, one of the best know API documentation courses on the web (receiving approx. 3,000 unique views a day!).

You can find the course at https://idratherbewriting.com/learnapidoc/.

In addition to writing course content (mostly about Graph QL), I am creating a video series, recording myself walking-through the course. This will be for people to follow along (via the audio as I read aloud the course material) and to help people who need more step-by-step direction throughout the activity sections of the course (by watching what I do on my screen).

KC Armstrong   YouTube2.jpg

https://www.youtube.com/channel/UCNfFd_BVMadG_R4T81nzgkQ


This has been an amazing internship so far where I am learning relevant skills for becoming an API writer. I plan to continue to work with the site after my internship is officially over because it is such a great opportunity. I will update this site with my progress as I get further along.

Stay tuned especially for my crash course for technical writers on GraphQL... Coming soon!

bottom of page