bobbyxcunningham.com

Professional Technical Writer

Month

July 2019

New topic in API course: Research on documenting code

I added another topic to the Documenting Code section in my API documentation course. This new topic is called Research on documenting code and summarizes/discusses two academic articles on documenting code. Source: I’d Rather Be Writing Feed

New topic in API course: Why documenting code is so difficult

I recently added a new section in my API documentation course on documenting code. This is an entire section that I’m building out with about 7-8 topics. The introduction is called Why documenting code is so difficult. Source: I’d Rather… Continue Reading →

WTD Episode 22: Managing multiple doc projects across Git repositories, with Giles Gaskell

In episode 22 of the Write the Docs podcast, Giles Gaskell from Squiz in Australia joins us to talk about managing multiple doc projects across Git repositories through Antora. Giles explains how to establish processes such that updating documentation becomes… Continue Reading →

Every project is a monster you battle and slay

Some tech comm projects are like monsters we battle. Is there any truth to the idea that it takes a monster to kill a monster? Source: I’d Rather Be Writing Feed

If I am learning to write developer documentation, should GraphQL be on my radar? — guest post by Casey Armstrong

GraphQL, a query language developed by Facebook, is an alternative to REST that is rising in popularity. Exactly how does GraphQL differ from REST, and what documentation strategies and conventions should you follow when documenting a GraphQL project? In this… Continue Reading →

© 2024 bobbyxcunningham.com — Powered by WordPress

Theme by Anders NorenUp ↑