bobbyxcunningham.com

Professional Technical Writer

Category

api-doc

Podcast with Jacob Moses on the Not-Boring Tech Writer: Skill #26: Getting Started with API Documentation

Jacob Moses has a podcast called The Not-Boring Tech Writer. Recently, he interviewed me for an episode titled Skill #26: Getting Started with API Documentation. Source: I’d Rather Be Writing Feed

New topic in API course: Five strategies for documenting code

Previous articles I’ve shared on documenting code introduced the complexity of the challenge. In this article, I expand on five different techniques writers take in documenting their code, including the Lego approach, the Nautilus approach, juxtaposed columns, and more. In… Continue Reading →

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 →

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

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 →

Recording of Tech Comm Trends Presentation (STC Puget Sound chapter)

I recently gave a presentation on technical communication trends to the STC Puget Sound Chapter in Seattle, Washington, on May 21, 2019. This is one of the better presentations on trends I’ve given and culminates a lot of research and… Continue Reading →

© 2024 bobbyxcunningham.com — Powered by WordPress

Theme by Anders NorenUp ↑