--- title: "API Documentation" description: "The api-doc category includes content related in some way to API documentation. Many times, this category includes mentions or references to new articles on my API documentation site. The following..." canonical_url: https://idratherbewriting.com/category-api-doc/index.html --- > For AI agents: a documentation index is available at https://idratherbewriting.com/llms.txt. Markdown versions of all pages are available by appending .md to any page URL. # API Documentation The api-doc category includes content related in some way to API documentation. Many times, this category includes mentions or references to new articles on my API documentation site. The following content is in the **api-doc** category: #### [Review of The MANIAC, by Benjamin Labatut -- thoughts on logic and the end of play](https://idratherbewriting.com/blog/review-maniac-labatut-rationality-end-of-play) | Aug 20, 2026 #### [API quick reference guides (and the challenges of passing long content into AI contexts)](https://idratherbewriting.com/blog/api-qrg-challenges-of-long-content) | Jun 1, 2025 #### [API quick reference diagrams and my upcoming AI the Docs presentation](https://idratherbewriting.com/blog/api-quick-reference-guides) | May 11, 2025 #### [New article added to API documentation site: Document360 for API docs](https://idratherbewriting.com/blog/document360-for-api-docs) | Apr 30, 2025 #### [Do developers need code samples in API documentation?](https://idratherbewriting.com/blog/code-samples-might-not-be-needed-anymore) | Mar 2, 2025 #### [Rethinking traditional approaches to release notes -- recording of WTD Australia presentation](https://idratherbewriting.com/blog/wtd-australia-release-notes-with-ai) | Feb 17, 2025 #### [From engineer interviews to written draft, with chain of thought reasoning](https://idratherbewriting.com/blog/prompt-eng-iterative-chain-of-thought) | Nov 3, 2024 #### [New API course on mastering documentation by Mark Wentowski on Docsgeek](https://idratherbewriting.com/blog/api-course-mark-docsgeek-mark-wentowski) | Nov 3, 2024 #### [Using long-token contexts to quality check an entire API doc set](https://idratherbewriting.com/blog/long-token-contexts-entire-doc-sets) | Jul 15, 2024 #### [Thoughts on Docs as code being a broken promise](https://idratherbewriting.com/blog/thoughts-on-docs-as-code-promise) | May 21, 2024 #### [Prompt engineering series: Creating scripts to automate doc build processes](https://idratherbewriting.com/blog/scripts-to-automate-doc-builds) | Apr 21, 2024 #### [Upcoming conference: AI the API docs](https://idratherbewriting.com/blog/ai-the-api-docs-conference-preso) | Apr 3, 2024 #### [Showcasing your API technical writer portfolio and projects — guest post by Peter Gustafson](https://idratherbewriting.com/blog/portfolios-api-docs-peter-gustafson) | Mar 12, 2024 #### [Visualizing APIs with tree diagrams, partly generated with AI](https://idratherbewriting.com/blog/task-decomposition-tree-diagram-example) | Feb 13, 2024 #### [Coffee Chat recording: Ask Me Anything about Managing API documentation projects](https://idratherbewriting.com/blog/ama-managing-api-documentation-projects) | Jan 8, 2024 #### [[Podcast] Breaking ground: New API documentation course at UW, with Bob Watson](https://idratherbewriting.com/blog/api-documentation-course-uw-bob-watson) | Jan 5, 2024 #### [My 2024 technical writing trends and predictions](https://idratherbewriting.com/blog/2024-tech-comm-trends-and-predictions) | Jan 1, 2024 #### [Podcast: Notes and themes from Zen and the Art of Motorcycle Maintenance by Robert Pirsig](https://idratherbewriting.com/blog/zen-and-art-of-motorcycle-maintenance-pirsig-notes-themes-podcast) | Dec 15, 2023 #### [Webinar: Let's talk API docs: a discussion about issues impacting documentation for APIs](https://idratherbewriting.com/blog/webinar-lets-talk-api-docs) | Dec 3, 2023 #### [Podcast: Tech writing and Zen and the Art of Motorcycle Maintenance, with Dan Grabski](https://idratherbewriting.com/blog/zen-motorcycle-maintenance-dan-grabski) | Nov 18, 2023 #### [You've heard of 'Docs as code' -- Now get ready for 'Code as docs': Q&A with Speakeasy](https://idratherbewriting.com/blog/speakeasy-question-answer-code-as-docs) | Nov 9, 2023 #### [[Podcast] AI and APIs: What works, what doesn't](https://idratherbewriting.com/blog/ai-apis-what-works-and-doesnt-video-recording-podcast) | Oct 14, 2023 #### [Forrester Report, Coding jobs, Hyper-personalization, RFPs, Call center replacement (Oct 9, 2023)](https://idratherbewriting.com/blog/links-from-web-oct-9) | Oct 9, 2023 #### [Documentation failures, Bestiaries, AI Explain post mortem, Inside TechComm podcast (Oct 3, 2023)](https://idratherbewriting.com/blog/links-web-oct3-2023) | Oct 2, 2023 #### [New article: AI and APIs: What works, what doesn't](https://idratherbewriting.com/blog/ai-and-apis-what-works-and-doesnt) | Sep 28, 2023 #### [Alphadoc: Build API documentation that tells your API's story](https://idratherbewriting.com/blog/alphadoc-question-and-answer) | Sep 17, 2023 #### [New API course topic: Using AI for summaries](https://idratherbewriting.com/blog/use-ai-for-summaries) | Sep 7, 2023 #### [New API doc course topic: Using AI for glossary definitions](https://idratherbewriting.com/blog/use-ai-glossaries-defs) | Sep 4, 2023 #### [New API doc course topic: Using AI for comparison tasks with API responses](https://idratherbewriting.com/blog/using-ai-for-comparison-tasks) | Aug 28, 2023 #### [New API doc course topic: Using AI For thematic analysis](https://idratherbewriting.com/blog/api-thematic-analysis) | Aug 28, 2023 #### [New API doc course topic: Using AI to learn coding](https://idratherbewriting.com/blog/use-ai-to-learn-coding) | Jul 25, 2023 #### [New topic in API course: Using AI tools to write build and publish scripts](https://idratherbewriting.com/blog/ai-tools-writing-build-and-publish-scripts) | Jul 19, 2023 #### [New topic in API doc course: AI document engineering with pattern-based prompts](https://idratherbewriting.com/blog/ai-document-engineering-patterns) | Jul 6, 2023 #### [Adding a new AI section to my API doc course](https://idratherbewriting.com/blog/new-ai-section-for-api-doc-course) | Jul 4, 2023 #### [First look at the Oxygen XML's AI Positron Assistant](https://idratherbewriting.com/blog/first-look-at-oxygen-xml-positron-assistant) | Jul 4, 2023 #### [New sections in API doc course exploring causes for poor product overviews and getting started tutorials](https://idratherbewriting.com/blog/new-section-product-overviews-getting-started-tutorials) | Jul 12, 2021 #### [Updated API Getting Started tutorial](https://idratherbewriting.com/blog/updated-getting-started-tutorial/) | Apr 19, 2021 #### [Updated Stoplight tutorial](https://idratherbewriting.com/blog/updated-stoplight-tutorial/) | Apr 12, 2021 #### [Updated glossary article with technical examples [API doc course]](https://idratherbewriting.com/blog/updated-glossary-article/) | Mar 18, 2021 #### [Product overviews -- a tricky space where documentation and marketing overlap](https://idratherbewriting.com/blog/writing-product-overviews/) | Feb 3, 2021 #### [Content Strategy Insights podcast with Larry Swanson about API documentation](https://idratherbewriting.com/blog/podcast-larry-swanson-api-documentation/) | Dec 2, 2020 #### [Finished up the section on documentation processes (for now)](https://idratherbewriting.com/blog/documentation-processes-articles-in-api-course/) | Nov 26, 2020 #### [How does Document360 handle challenges with API documentation? A practical review](https://idratherbewriting.com/blog/document-360-review/) | Nov 10, 2020 #### [Coffee and Content webinar recording: Treat Code Like Code; Treat Prose Like Prose](https://idratherbewriting.com/blog/coffee-and-content-webinar-code-like-code-prose-like-prose/) | Oct 2, 2020 #### [SmartBear's 2020 API report finds 'Accurate and detailed documentation' to be second-most important characteristic of APIs](https://idratherbewriting.com/blog/smartBear-2020-state-of-api-docs-review/) | Sep 10, 2020 #### [Redocly tutorial added to API course](https://idratherbewriting.com/blog/redocly-tutorial/) | Sep 8, 2020 #### [New article in API course -- Questions to ask during a documentation kickoff and demo](https://idratherbewriting.com/blog/kickoff-meeting-and-demo-agenda/) | Sep 2, 2020 #### [ISTC article on developer documentation trends](https://idratherbewriting.com/blog/developer-documentation-trends-istc-article/) | Aug 31, 2020 #### [Developer portal strategies for complex landscapes -- conversation with Kristof van Tomme](https://idratherbewriting.com/blog/developer-portal-strategies-complex-landscapes-kristof-van-tomme/) | Jun 24, 2020 #### [API the Docs recording: How Trends in API Documentation Differ from other Tech Comm Trends](https://idratherbewriting.com/blog/api-the-docs-virtual-series-fifth-edition-api-doc-trends-design/) | Jun 4, 2020 #### [Podcast: Building Great Documentation -- WAPI FM radio hour](https://idratherbewriting.com/blog/wapi-radio-building-great-documentation-recording/) | May 7, 2020 #### [API doc course update: Re-architecting the OpenAPI spec tutorials to start with visual modeling tools first, then code](https://idratherbewriting.com/blog/api-docs-start-with-visual-first/) | Apr 28, 2020 #### [API The Docs Virtual Series 2020 -- Upcoming presentations and thoughts on the virtual format](https://idratherbewriting.com/blog/api-the-docs-virtual-conference-2020/) | Apr 14, 2020 #### [Are technical writers increasingly playing non-technical roles? Some thoughts on the evolution of technical writing roles](https://idratherbewriting.com/blog/evolving-roles-of-technical-wrters/) | Mar 30, 2020 #### [Podcast: Users as producers of knowledge -- conversation with Nupoor Ranade about how tech writer roles are changing](https://idratherbewriting.com/blog/users-as-producers-of-knowledge-nupoor-ranade/) | Mar 29, 2020 #### [Webinar recording: How Trends in API Documentation Differ from other Tech Comm Trends](https://idratherbewriting.com/blog/upcoming-webinar-trends-api-docs-differ-from-other-trends/) | Mar 12, 2020 #### [Introduction to API documentation - Recording from Los Angeles API documentation workshop](https://idratherbewriting.com/blog/introduction-to-api-documentation-la-workshop-recording/) | Mar 11, 2020 #### [Podcast: How Paligo is filling a niche in the CCMS market for complex documentation, with Anders Svensson](https://idratherbewriting.com/blog/paligo-filling-a-niche-in-ccms-market-for-complex-docs/) | Mar 9, 2020 #### [Checklist of different types of API docs](https://idratherbewriting.com/blog/doc-suite-checklist/) | Feb 25, 2020 #### [Podcast with Andrew Davis: Hiring API doc writers -- an inside look at fixing broken processes](https://idratherbewriting.com/blog/podcast-andrew-davis-hiring-api-doc-writers-inside-look-fixing-broken-processes/) | Feb 23, 2020 #### [Tools FAQ for API doc site](https://idratherbewriting.com/blog/tools-faq-for-api-doc-site/) | Feb 13, 2020 #### [From API docs to developer portals](https://idratherbewriting.com/blog/from-api-docs-to-developer-portals/) | Feb 9, 2020 #### [Updated Intro to API documentation topic](https://idratherbewriting.com/blog/updated-intro-to-api-documentation-topic/) | Jan 9, 2020 #### [2020 Developer documentation survey](https://idratherbewriting.com/blog/developer-documentation-survey-2020/) | Dec 31, 2019 #### [Podcast: API Design and Usability with Arnaud Lauret (API Handyman)](https://idratherbewriting.com/blog/api-design-usability-arnaud-lauret-podcast/) | Dec 7, 2019 #### [Upcoming API Documentation Workshop in Los Angeles, Calif., on January 23, 2020](https://idratherbewriting.com/blog/upcoming-api-documentation-workshop-los-angeles-jan-23/) | Dec 2, 2019 #### [Reflecting on my latest SF API doc workshop](https://idratherbewriting.com/2019/12/02/reflections-on-latest-workshop/) | Dec 2, 2019 #### [Podcast with Jacob Moses on the Not-Boring Tech Writer: Skill #26: Getting Started with API Documentation](https://idratherbewriting.com/2019/10/03/podcast-with-jacob-moses-on-api-documentation/) | Oct 3, 2019 #### [Podcast: 10 myths about API documentation](https://idratherbewriting.com/blog/ten-myths-about-api-documentation/) | Sep 29, 2019 #### [Expanding embedded Swagger UI instances in your docs](https://idratherbewriting.com/blog/embed-swagger-ui-in-your-docs/) | Sep 29, 2019 #### [An inside look at DeveloperHub -- hosted documentation portals for API docs](https://idratherbewriting.com/blog/developerhub-product-faq/) | Sep 10, 2019 #### [Upcoming API Documentation Workshop in San Francisco, Calif., on November 19, 2019](https://idratherbewriting.com/blog/upcoming-api-doc-workshop-san-francisco-nov-19/) | Sep 9, 2019 #### [New topic in API course: Five strategies for documenting code](https://idratherbewriting.com/blog/strategies-for-documenting-code/) | Aug 8, 2019 #### [New topic in API course: Research on documenting code](https://idratherbewriting.com/blog/research-on-documenting-code/) | Jul 29, 2019 #### [New topic in API course: Why documenting code is so difficult](https://idratherbewriting.com/blog/why-documenting-code-is-so-difficult/) | Jul 29, 2019 #### [Upcoming API Documentation Workshop in Mountain View, Calif., on August 30, 2019](https://idratherbewriting.com/2019/07/08/upcoming-api-documention-workshop-mountainview/) | Jul 8, 2019 #### [If I am learning to write developer documentation, should GraphQL be on my radar? -- guest post by Casey Armstrong](https://idratherbewriting.com/blog/graphql-relevance-and-documentation-strategies/) | Jul 1, 2019 #### [Recording of Tech Comm Trends Presentation (STC Puget Sound chapter)](https://idratherbewriting.com/blog/tech-comm-trends-stc-puget-sound/) | Jun 8, 2019 #### [New video recordings of Raleigh API documentation workshop now available](https://idratherbewriting.com/blog/video-recordings-for-raleigh-api-documentation-workshop/) | Apr 21, 2019 #### [Upcoming API workshops in Raleigh (April 6) and Denver (May 5)](https://idratherbewriting.com/2019/04/01/upcoming-api-workshops/) | Apr 1, 2019 #### [Results from survey about engineers who write documentation](https://idratherbewriting.com/2019/03/21/trends-with-engineers-writing-docs/) | Mar 21, 2019 #### [How to design API documentation for opportunistic (active, experiential) learning styles](https://idratherbewriting.com/2019/03/07/how-to-design-api-documentation-for-opportunistic-behavior/) | Mar 7, 2019 #### [Site analytics from Jan 1 to Dec 31, 2018 -- are more engineers writing docs now?](https://idratherbewriting.com/2019/01/14/site-analytics-from-2018-59-percent-traffic-going-to-api-doc-site/) | Jan 14, 2019 #### [Research on code documentation -- when not to comment on code](https://idratherbewriting.com/2018/12/20/when-not-to-comment-on-code/) | Dec 20, 2018 #### [Recording for Menlo Park API documentation workshop now available -- and some thoughts on using cardioid versus omnidirectional microphones for recording](https://idratherbewriting.com/2018/12/04/api-documentation-workshop-menlo-park-recording/) | Dec 4, 2018 #### [My upcoming presentation and workshop at the 2019 STC Summit in Denver](https://idratherbewriting.com/2018/11/29/upcoming-presentations-at-stc-summit/) | Nov 29, 2018 #### [Bibliography of API documentation articles](https://idratherbewriting.com/2018/11/25/api-documentation-bibliography/) | Nov 25, 2018 #### [Upcoming full-day API documentation workshop in Menlo Park](https://idratherbewriting.com/2018/10/31/upcoming-api-doc-workshop/) | Oct 31, 2018 #### [Preferring technical acuity over specialized knowledge](https://idratherbewriting.com/2018/10/24/technical-aptitude/) | Oct 24, 2018 #### [Tech comm trends -- why tech writers will be collaborating more with engineers](https://idratherbewriting.com/2018/10/09/tech-comm-trends-more-collaboration-with-engineers/) | Oct 9, 2018 #### [Tech comm trends: Providing value as a generalist in a sea of specialists (Part I)](https://idratherbewriting.com/2018/10/02/providing-value-as-generalists-in-specialist-contexts-part-1/) | Oct 2, 2018 #### [Tech comm trends: Providing value as a generalist in a sea of specialists (Part II)](https://idratherbewriting.com/2018/10/02/providing-value-as-generalists-in-specialist-contexts-part-2/) | Oct 2, 2018 #### [Tech comm trends: Providing value as a generalist in a sea of specialists (Part III)](https://idratherbewriting.com/2018/10/02/providing-value-as-generalists-in-specialist-contexts-part-3/) | Oct 2, 2018 #### [Tech comm trends: Providing value as a generalist in a sea of specialists (Part IV)](https://idratherbewriting.com/2018/10/02/providing-value-as-generalists-in-specialist-contexts-part-4/) | Oct 2, 2018 #### [Tech comm trends: Providing value as a generalist in a sea of specialists (Part V)](https://idratherbewriting.com/2018/10/02/providing-value-as-generalists-in-specialist-contexts-part-5/) | Oct 2, 2018 #### [Tech comm trends: Providing value as a generalist in a sea of specialists (Part VI)](https://idratherbewriting.com/2018/10/02/providing-value-as-generalists-in-specialist-contexts-part-6/) | Oct 2, 2018 #### [Tech comm trends: Providing value as a generalist in a sea of specialists (Part VII)](https://idratherbewriting.com/2018/10/02/providing-value-as-generalists-in-specialist-contexts-part-7/) | Oct 2, 2018 #### [Getting a job in API documentation -- new topics and expansions in my API doc course](https://idratherbewriting.com/2018/08/22/expanded-sections-in-getting-an-api-doc-job/) | Aug 22, 2018 #### [Strategies for learning technology -- podcast recommendation and a poll](https://idratherbewriting.com/2018/08/10/how-much-time-devoted-to-learning-tech-is-needed/) | Aug 10, 2018 #### [Thoughts on docs-as-code after 3 years -- it works!](https://idratherbewriting.com/2018/07/03/docs-as-code-after-three-years/) | Jul 3, 2018 #### [Non-Reference Content section updated in API course](https://idratherbewriting.com/2018/06/12/updated-the-nonref-sections-in-api-course/) | Jun 12, 2018 #### [Replaced the previous weather API example in my API course to now use OpenWeatherAPI](https://idratherbewriting.com/2018/04/28/replaced-old-mashape-api-example-in-api-doc-course/) | Apr 28, 2018 #### [Recording of API documentation workshop in Denver](https://idratherbewriting.com/2018/03/12/api-documentation-workshop-in-denver/) | Mar 12, 2018 #### [Recording of Docs-as-code tools and workflows presentation](https://idratherbewriting.com/2018/03/09/docs-as-code-tools-and-workflows-denver-presentation/) | Mar 9, 2018 #### [Recording of STC San Francisco presentation: Beyond mere endpoint reference — the overlooked content in API documentation](https://idratherbewriting.com/2018/03/08/stc-sf-preso-nonreference-api-docs/) | Mar 8, 2018 #### [Recording of OpenAPI and Swagger presentation (for STC and WTD San Diego)](https://idratherbewriting.com/2018/02/14/openapi-and-swagger-presentation/) | Feb 14, 2018 #### [Write the Docs Podcast episode 13: Postman for API development and docs — Interview with Postman Founder](https://idratherbewriting.com/2018/01/22/postman-for-docs-podcast/) | Jan 22, 2018 #### [Recording of WTD South Bay presentation: Publishing tools for API documentation](https://idratherbewriting.com/2018/01/19/wtd-south-bay-publish-api-documentation-presentation/) | Jan 19, 2018 #### [Case study: Switching tools to docs-as-code](https://idratherbewriting.com/2017/11/21/switching-to-docs-as-code/) | Nov 21, 2017 #### [Intro to API Documentation -- recording of presentation to STC Silicon Valley chapter on 11/20/2017](https://idratherbewriting.com/2017/11/19/upcoming-api-doc-presentation-stc-sv-chapter/) | Nov 19, 2017 #### [New OpenAPI 3.0 specification tutorial in my API Course](https://idratherbewriting.com/2017/11/07/openapi-30-swagger-tutorial-api-course/) | Nov 7, 2017 #### [Question: Which software tools should I use if my goal is to write API docs?](https://idratherbewriting.com/2017/10/12/which-tool-for-developer-documentation/) | Oct 12, 2017 #### [SwaggerHub: A collaborative platform for working on OpenAPI/Swagger specification files, and more](https://idratherbewriting.com/2017/10/05/swaggerhub-collaborative-platform-for-swagger-openapi-projects/) | Oct 5, 2017 #### [Discoveries and realizations while walking down the Docs-as-Code path](https://idratherbewriting.com/2017/08/23/content-architecture-and-repo-sizes/) | Aug 23, 2017 #### [Write the Docs Podcast episode 8: Stack Overflow's Documentation Failure and Open Source Challenges](https://idratherbewriting.com/2017/08/22/write-the-docs-episode-8-stack-overflow/) | Aug 22, 2017 #### [Why simple language isn't so simple: the struggle to create plain language in documentation](https://idratherbewriting.com/2017/07/27/why-simple-language-isnt-so-simple/) | Jul 27, 2017 #### [Limits to the idea of treating docs as code](https://idratherbewriting.com/2017/06/02/when-docs-are-not-like-code/) | Jun 2, 2017 #### [How big should your documentation repo be?](https://idratherbewriting.com/2017/05/26/big-repos-versus-small-repos/) | May 26, 2017 #### [Impressions from the Write the Docs Conference -- and thoughts on achieving sustainability without selling out to vendors](https://idratherbewriting.com/2017/05/23/write-the-docs-and-the-battle-against-vendor-evil/) | May 23, 2017 #### [Testing your documentation -- updates in API doc course](https://idratherbewriting.com/2017/05/04/2017-testing-your-docs/) | May 4, 2017 #### [My Calm Meditation app -- another experiment to test my docs](https://idratherbewriting.com/2017/04/27/calm-meditation-app/) | Apr 27, 2017 #### [Write the Docs Podcast app now on Fire TV, and the importance of testing your docs with sample apps](https://idratherbewriting.com/2017/04/09/write-the-docs-app-on-fire-tv/) | Apr 9, 2017 #### [Moved my API doc site into separate repo](https://idratherbewriting.com/2017/03/30/moved-my-api-doc-site-into-separate-path/) | Mar 30, 2017 #### [Crowdsourcing docs with docs-as-code tools -- same result as with wikis?](https://idratherbewriting.com/2017/03/08/crowdsourcing-docs-with-github-docs-as-code-tools-same-as-wikis/) | Mar 8, 2017 #### [Write the Docs Podcast Episode 4 -- Continuous Integration and Docs as Code](https://idratherbewriting.com/2017/03/06/write-the-docs-podcast-continuous-integration-and-docs-as-code/) | Mar 6, 2017 #### [How do you learn what you need to learn to be successful as a technical writer?](https://idratherbewriting.com/2017/02/24/how-to-learn-what-you-need-to-learn/) | Feb 24, 2017 #### [Guest post: Design choices for organizing API reference content with other documentation](https://idratherbewriting.com/2017/02/21/designing-good-static-api-docs/) | Feb 21, 2017 #### [Technical Writing Trends and Predictions for 2017](https://idratherbewriting.com/2017/01/28/technical-writing-trends-for-2017/) | Jan 28, 2017 #### [Simplified Technical English and HyperSTE](https://idratherbewriting.com/2017/01/25/hyperste-simplified-technical-english-asd-ste100/) | Jan 25, 2017 #### [Recording: Modern Technical Writing, by Andrew Etter (STC Silicon Valley chapter)](https://idratherbewriting.com/2017/01/24/modern-technical-writing-andrew-etter-presentation/) | Jan 24, 2017 #### [My top 3 posts of 2016 are all Swagger-related -- lessons learned from 2016 analytics](https://idratherbewriting.com/2017/01/17/trends-2017-swagger-all-the-way/) | Jan 17, 2017 #### [Swagger presentation recording -- Harnessing the Chi of Swagger in your REST API documentation](https://idratherbewriting.com/2017/01/17/swagger-presentation-documenting-rest-apis/) | Jan 17, 2017 #### [How much code do you need to know to create API developer documentation?](https://idratherbewriting.com/2017/01/06/how-much-code-do-you-need-to-know/) | Jan 6, 2017 #### [Attend my upcoming TC Dojo presentation on Swagger on Jan 9, 2017](https://idratherbewriting.com/2017/01/06/upcoming-swagger-tc-dojo-presentation/) | Jan 6, 2017 #### [Recording of Open Authoring -- Collaboration Across Disciplines presentation, by Ralph Squillace](https://idratherbewriting.com/2016/11/15/recording-of-open-authoring-collaboration-ralph-squillace/) | Nov 15, 2016 #### [Review of Coding for Writers course by Peter Gruenbaum on Udemy](https://idratherbewriting.com/2016/11/13/review-of-coding-for-writers-peter-gruenbaum-udacity/) | Nov 13, 2016 #### [Implementing Swagger in your API documentation -- My ISTC article](https://idratherbewriting.com/2016/09/08/swagger-article-for-istc-publication/) | Sep 8, 2016 #### [Presentation recording: Hunting for API developer documentation jobs in the San Francisco Bay area, by Andrew Davis](https://idratherbewriting.com/2016/08/15/api-developer-documentation-jobs-san-francisco-bay-area/) | Aug 15, 2016 #### [The complexities of translation and the need for dynamic variables in the build process](https://idratherbewriting.com/2016/08/15/translation-complexities-static-site-generations-need-dynamic-variables/) | Aug 15, 2016 #### [Will the docs-as-code approach scale? Responding to comments on my Review of Modern Technical Writing](https://idratherbewriting.com/2016/08/01/responding-to-feedback-on-modern-tech-writing-review/) | Aug 1, 2016 #### [Review of Andrew Etter's ebook on Modern Technical Writing](https://idratherbewriting.com/2016/07/26/modern-technical-writing-review/) | Jul 26, 2016 #### [Some post-STC Summit thoughts](https://idratherbewriting.com/2016/05/20/conference-recap-and-thoughts-stc-summit-2016/) | May 20, 2016 #### [Slides for Documenting REST APIs Workshop — 2016 STC Summit Anaheim, Calif.](https://idratherbewriting.com/2016/05/14/slides-for-api-workshop-stc-summit-anaheim/) | May 14, 2016 #### [API documentation workshop opportunity at the STC Summit](https://idratherbewriting.com/2016/04/07/api-workshop-stc-summit/) | Apr 7, 2016 #### [REST API documentation workshop recording (STC Sacramento)](https://idratherbewriting.com/2016/03/27/rest-api-workshop-recording-sacramento-stc/) | Mar 27, 2016 #### [10 minute podcast on API technical writing with Ryan Weber on Stitcher](https://idratherbewriting.com/2016/03/12/api-technical-writing-podcast-ryan-weber-stitcher/) | Mar 12, 2016 #### [What is the ideal tool for developer documentation environments?](https://idratherbewriting.com/2016/02/21/ideal-tool-for-developer-doc/) | Feb 21, 2016 #### [Two upcoming API documentation events this Thursday](https://idratherbewriting.com/2016/02/16/upcoming-stc-webinar-rest-api-documentation-best-practices/) | Feb 16, 2016 #### [The third API course from Peter Gruenbaum on Udemy](https://idratherbewriting.com/2016/02/08/third-api-course-from-peter-gruenbaum/) | Feb 8, 2016 #### [Upcoming REST API documentation workshop in Sacramento](https://idratherbewriting.com/2016/02/08/rest-api-documentation-workshop-sacramento-california/) | Feb 8, 2016 #### [New section in API documentation course: The Job Market for API technical Writers](https://idratherbewriting.com/2016/02/08/new-section-api-documentation-jobs/) | Feb 8, 2016 #### [Challenges in documenting long JSON objects](https://idratherbewriting.com/2016/01/21/describing-long-json-objects/) | Jan 21, 2016 #### [Spec-driven Development with RAML -- presentation by Michael Stowe to STC Silicon Valley chapter](https://idratherbewriting.com/2016/01/09/michael-stowe-spec-driven-development-stc-sv-presentation/) | Jan 9, 2016 #### [First video for API documentation course -- your feedback?](https://idratherbewriting.com/2016/01/07/first-api-doc-course-video/) | Jan 7, 2016 #### [My 2016 technical writing trends and predictions, or the ripple effects of API growth on technical writers](https://idratherbewriting.com/2015/12/29/trends-technical-writing-2016/) | Dec 29, 2015 #### [My upcoming 2016 STC Summit workshop and presentation](https://idratherbewriting.com/2015/12/22/upcoming-stc-summit-presentations/) | Dec 22, 2015 #### [How do you stay updated with changes developers are silently making?](https://idratherbewriting.com/2015/12/20/2015-how-to-integrate-into-developer-workflows/) | Dec 20, 2015 #### [Those pesky authoring tool questions, and an update on my adventures with Jekyll](https://idratherbewriting.com/2015/12/19/those-authoring-tool-questions/) | Dec 19, 2015 #### [Recording of Version Control, Writers, and Worfklows by Richard Mateosian](https://idratherbewriting.com/2015/12/17/recording-of-writers-workflows-richard-mateosian/) | Dec 17, 2015 #### [Swagger UI probably the coolest thing I've done in API docs](https://idratherbewriting.com/2015/12/13/using-swagger-for-api-documentation/) | Dec 13, 2015 #### [10 realizations as I was creating my Swagger spec and Swagger UI](https://idratherbewriting.com/2015/12/10/ten-realizations-using-swagger-and-swagger-ui/) | Dec 10, 2015 #### [Single sourcing the Swagger spec and main documentation using Jekyll](https://idratherbewriting.com/2015/12/03/overcoming-doc-fragmentation-with-swagger-spec/) | Dec 3, 2015 #### [Podcast: Spec-driven Development of REST APIs, with a focus on RAML -- interview with Michael Stowe](https://idratherbewriting.com/2015/10/12/spec-driven-design-podcast-michael-stowe/) | Oct 12, 2015 #### [5 REST API resources to add to your reading list](https://idratherbewriting.com/2015/10/03/rest-api-resources/) | Oct 3, 2015 #### [Tutorial for creating interactive consoles with RAML](https://idratherbewriting.com/2015/10/03/RAML-tutorial-notes/) | Oct 3, 2015 #### [Why so little focus on API doc at tech comm conferences?](https://idratherbewriting.com/2015/09/30/submit-something-api-related-to-stc-summit/) | Sep 30, 2015 #### [Question: How long has your API doc course been available?](https://idratherbewriting.com/2015/09/29/how-long-has-your-api-doc-course-been-available/) | Sep 29, 2015 #### [Question: How do I tell what platform people are using for API docs?](https://idratherbewriting.com/2015/09/28/what-platforms-is-everyone-using-for-api-docs/) | Sep 28, 2015 #### [Added native library API section to API doc course](https://idratherbewriting.com/2015/09/26/adding-platform-apidoc-section/) | Sep 26, 2015 #### [Swagger tutorial for REST API documentation](https://idratherbewriting.com/2015/09/14/swagger-tutorial/) | Sep 14, 2015 #### [Editing workflows and reviews through Github's pull requests](https://idratherbewriting.com/2015/09/10/edits-through-pull-requests/) | Sep 10, 2015 #### [Comparing object-oriented design to content reuse](https://idratherbewriting.com/2015/09/10/comparing-programming-to-reuse/) | Sep 10, 2015 #### [How authorization works with APIs](https://idratherbewriting.com/2015/09/04/authorizing-apis/) | Sep 4, 2015 #### [What is a REST API?](https://idratherbewriting.com/2015/08/28/all-about-rest-apis/) | Aug 28, 2015 #### [Podcast: How do design, length, and relevance affect how people use API reference docs -- interview with Bob Watson](https://idratherbewriting.com/2015/07/30/bob-watson-phd-dissertation-on-api-doc-mythbusting-testing-usability-performance/) | Jul 30, 2015 #### [Peter Gruenbaum has released part 2 of his Udemy course on API technical writing](https://idratherbewriting.com/2015/07/24/udemy-course-on-api-technical-writing-part-two/) | Jul 24, 2015 #### [Survey results about the possible REST API workshop](https://idratherbewriting.com/2015/07/24/survey-results-about-rest-api-course/) | Jul 24, 2015 #### [Survey about possible REST API workshop — your feedback would be helpful](https://idratherbewriting.com/2015/07/20/survey-about-possible-rest-api-workshop/) | Jul 20, 2015 #### [Reader question: How do I move forward out of a stagnant tech writing career?](https://idratherbewriting.com/2015/07/15/moving-a-stagnant-career-forward/) | Jul 15, 2015 #### [Listen to Ed Marsh's Content Content podcast with me as a guest](https://idratherbewriting.com/2015/07/08/podcast-with-ed-marsh-on-content-content/) | Jul 8, 2015 #### [Slides, notes, and lessons learned at the STC Summit 2015 in Columbus, Ohio](https://idratherbewriting.com/2015/06/29/lessons-learned-at-the-stc-summit-2015/) | Jun 29, 2015 #### [Integrating Documentation into engineering code and workflows](https://idratherbewriting.com/2015/05/26/integrating-documentation-into-engineering-code-and-workflows/) | May 26, 2015 #### [API technical writing course on Udemy from Peter Gruenbaum, and some thoughts on documenting JSON](https://idratherbewriting.com/2015/05/22/api-technical-writing-course-on-udemy/) | May 22, 2015 #### [API Documentation presentation to East Bay STC chapter -- slides and recording](https://idratherbewriting.com/2015/05/16/api-documentation-presentation-to-east-bay-stc-chapter/) | May 16, 2015 #### [Recording of API documentation workshop (REST and Javadoc) at tcworld India 2015](https://idratherbewriting.com/2015/03/19/recording-of-api-documentation-workshop-rest-and-javadoc-at-tcworld-india-2015/) | Mar 19, 2015 #### [Recording of Innovation in Technical Communication keynote at tcworld India 2015](https://idratherbewriting.com/2015/03/18/recording-of-innovation-in-technical-communication-keynote-at-tcworld-india-2015/) | Mar 18, 2015 #### [Slides for tcworld India 2015 presentations](https://idratherbewriting.com/2015/03/11/slides-for-tcworld-india-2015-presentations/) | Mar 11, 2015 #### [Best practices for API documentation -- podcast with Andrya Feinberg](https://idratherbewriting.com/2015/02/04/best-practices-for-api-documentation-podcast-with-andrya-feinberg/) | Feb 4, 2015 #### [Survival strategies for API documentation -- slides and recording](https://idratherbewriting.com/2015/02/03/upcoming-webinar-survival-strategies-for-api-documentation/) | Feb 3, 2015 #### [Creating context-sensitive help by converting your help into a JSON API with Jekyll](https://idratherbewriting.com/2015/02/01/creating-context-sensitive-help-by-converting-your-help-into-a-json-api/) | Feb 1, 2015 #### [10 reasons for moving away from DITA](https://idratherbewriting.com/2015/01/28/10-reasons-for-moving-away-from-dita/) | Jan 28, 2015 #### [API workshop video + audio + slides + workshop files from TC Camp](https://idratherbewriting.com/2015/01/27/api-workshop-video-audio-slides-workshop-files-from-tc-camp/) | Jan 27, 2015 #### [Implementing ScrollSpy with Jekyll to auto-build a table of contents](https://idratherbewriting.com/2015/01/20/implementing-scrollspy-with-jekyll-to-auto-build-a-table-of-contents/) | Jan 20, 2015 #### [Moving from passive to reactive documentation -- recording of presentation by Greg Koberger, ReadMe.com founder](https://idratherbewriting.com/2015/01/19/moving-from-passive-to-reactive-documentation-recording-of-presentation-by-greg-koberger-readme-io-founder/) | Jan 19, 2015 #### [Most important factor in APIs is complete and accurate documentation](https://idratherbewriting.com/2015/01/15/most-important-factor-in-apis-is-complete-and-accurate-documentation/) | Jan 15, 2015 #### [API doc survey: Do engineers write API doc in the source code?](https://idratherbewriting.com/2015/01/15/api-doc-survey-do-engineers-write-api-doc-in-the-source-code/) | Jan 15, 2015 #### [API doc survey: How much of your doc process is automated?](https://idratherbewriting.com/2015/01/15/api-doc-survey-how-much-of-your-doc-process-is-automated/) | Jan 15, 2015 #### [Several REST API tutorials using the EventBrite, Klout, and Flickr APIs](https://idratherbewriting.com/2015/01/14/several-rest-api-tutorials-using-the-eventbrite-klout-and-flickr-apis/) | Jan 14, 2015 #### [API doc survey: Most challenging aspect of API documentation](https://idratherbewriting.com/2015/01/12/api-doc-survey-most-challenging-aspect-of-api-documentation/) | Jan 12, 2015 #### [Jan 12 Silicon Valley STC meeting: Passive vs. reactive doc + readme.com](https://idratherbewriting.com/2015/01/11/jan-12-silicon-valley-stc-meeting-passive-vs-reactive-doc-readme-io/) | Jan 11, 2015 #### [Podcast: Unifying the API doc publishing toolchain, with Mark Baker](https://idratherbewriting.com/2015/01/08/podcast-unifying-the-api-doc-publishing-toolchain-with-mark-baker/) | Jan 8, 2015 #### [API doc survey result: How to learn what you need to know?](https://idratherbewriting.com/2015/01/07/api-doc-survey-result-how-to-learn-what-you-need-to-know/) | Jan 7, 2015 #### [API doc survey result: How do you get the source files that contain code comments?](https://idratherbewriting.com/2015/01/06/api-doc-survey-result-how-do-you-get-the-source-files-that-contain-code-comments/) | Jan 6, 2015 #### [Podcast: Automating REST API documentation, with Peter Gruenbaum](https://idratherbewriting.com/2015/01/05/podcast-automating-rest-api-documentation-with-peter-gruenbaum/) | Jan 5, 2015 #### [My *real* top 10 technical writing trend predictions for 2015](https://idratherbewriting.com/2015/01/05/my-real-top-10-technical-writing-trend-predictions-for-2015/) | Jan 5, 2015 #### [Top 10 posts, podcasts, tweets of 2014 -- and what it all means](https://idratherbewriting.com/2015/01/05/top-10-posts-podcasts-tweets-of-2014-and-what-it-all-means/) | Jan 5, 2015 #### [API doc survey: Do you create API doc by looking at source code?](https://idratherbewriting.com/2015/01/02/api-doc-survey-do-you-create-doc-by-looking-at-source-code/) | Jan 2, 2015 #### [API doc survey: What IDE do you use?](https://idratherbewriting.com/2015/01/02/api-doc-survey-what-ide-do-you-use/) | Jan 2, 2015 #### [API doc survey: Do you test out the API calls used in your doc yourself?](https://idratherbewriting.com/2015/01/02/api-doc-survey-do-you-test-out-the-api-calls-used-in-your-doc-yourself/) | Jan 2, 2015 #### [Question: Where are API documentation jobs for technical writers located?](https://idratherbewriting.com/2014/12/24/question-where-are-api-documentation-jobs-for-technical-writers-located/) | Dec 24, 2014 #### [API doc survey: Authoring tools preferred by API documentation writers](https://idratherbewriting.com/2014/12/24/authoring-tools-preferred-by-api-doc-writers-in-my-survey/) | Dec 24, 2014 #### [Learning how developers think, and other API doc insights: Podcast with Joe Malin](https://idratherbewriting.com/2014/12/22/learning-how-developers-think-and-other-api-doc-insights-podcast-with-joe-malin/) | Dec 22, 2014 #### [API doc survey: The most common programming languages tech writers know](https://idratherbewriting.com/2014/12/22/most-common-programming-languages-tech-writers-in-my-survey-know/) | Dec 22, 2014 #### [API doc survey: The most popular type of APIs that technical writers document](https://idratherbewriting.com/2014/12/17/the-most-popular-type-of-apis-that-technical-writers-document/) | Dec 17, 2014 #### [Getting a job in API documentation: Podcast with Andrew Davis](https://idratherbewriting.com/2014/12/17/getting-a-job-in-api-documentation-podcast-with-andrew-davis/) | Dec 17, 2014 #### [I need your responses to my API Documentation Survey](https://idratherbewriting.com/2014/12/12/i-need-your-responses-to-my-api-documentation-survey/) | Dec 12, 2014 #### [Podcast download stats kind of mind-blowing](https://idratherbewriting.com/2014/12/09/podcast-download-stats-kind-of-mind-blowing/) | Dec 9, 2014 #### [Upcoming API Workshop with Sarah Maddox](https://idratherbewriting.com/2014/11/28/upcoming-api-workshop-with-sarah-maddox/) | Nov 28, 2014 #### [Flat file systems versus database models for help](https://idratherbewriting.com/2014/11/05/flat-file-systems-versus-database-models-for-help/) | Nov 5, 2014 #### [API and SDK documentation: Notes from Ed Marshall's Workshop at Information Development World](https://idratherbewriting.com/2014/10/25/notes-from-ed-marshalls-api-and-sdk-workshop-at-information-development-world/) | Oct 25, 2014 #### [API Doc presentation slides and recording (San Francisco STC chapter)](https://idratherbewriting.com/2014/10/16/api-doc-presentation-slides-and-recording/) | Oct 16, 2014 #### [Import DITA's XHTML Output into WordPress](https://idratherbewriting.com/2014/10/14/import-dita-xhtml-output-into-wordpress/) | Oct 14, 2014 #### [Why developers will never adopt DITA](https://idratherbewriting.com/2014/09/30/why-developers-will-never-adopt-dita/) | Sep 30, 2014 #### [STC Intercom Issue Entirely Dedicated to API Documentation](https://idratherbewriting.com/2014/09/10/stc-intercom-issue-entirely-dedicated-to-api-documentation/) | Sep 10, 2014 #### [Upcoming presentation in downtown San Francisco: Publishing strategies for API documentation](https://idratherbewriting.com/2014/09/02/upcoming-presentation-publishing-strategies-api-documentation/) | Sep 2, 2014 #### [Introduction to API documentation: Interview with Scot Marvin](https://idratherbewriting.com/2014/06/16/introduction-to-api-documentation-interview-with-scot-marvin/) | Jun 16, 2014 #### [Lessons learned as a novice API technical writer -- Interview with Mary Linderman (podcast)](https://idratherbewriting.com/2014/06/08/lessons-learned-as-a-novice-api-technical-writer-interview-with-mary-linderman-podcast/) | Jun 8, 2014 #### [The future of tech comm is developer doc](https://idratherbewriting.com/2014/06/03/the-future-of-tech-comm-is-developer-doc/) | Jun 3, 2014 #### [Creating code samples for API/SDK documentation (webinar recording, slides, and audio)](https://idratherbewriting.com/2014/05/30/creating-code-samples-webinar-recording-slides-and-audio/) | May 30, 2014 #### [Upcoming webinar: Creating code samples for API/SDK documentation](https://idratherbewriting.com/2014/05/09/upcoming-webinar-creating-code-samples-for-apisdk-documentation/) | May 9, 2014 #### [Writers needed for Intercom issue on API documentation](https://idratherbewriting.com/2014/02/26/writers-needed-for-intercom-issue-on-api-documentation/) | Feb 26, 2014 #### [Growing trends for APIs and my favorite resources to learn technical information](https://idratherbewriting.com/2014/01/20/growing-trends-for-apis-and-my-favorite-resources-to-learn-technical-information/) | Jan 20, 2014 #### [Single-page docs versus "Click Insanity"](https://idratherbewriting.com/2014/01/12/single-page-docs-versus-click-insanity/) | Jan 12, 2014 #### [Tips for writing code comments in developer documentation](https://idratherbewriting.com/2014/01/11/tips-for-writing-code-comments-in-developer-documentation/) | Jan 11, 2014 #### [How Do You Teach New Users Programming?](https://idratherbewriting.com/2013/04/19/how-do-you-teach-new-users-programming/) | Apr 19, 2013