Description: Stay updated with best practices for technical writers. Includes an API documentation course for technical writers and engineers learning how to document APIs. The course includes sections on what an API is, API reference documentation, OpenAPI specification and Swagger, docs-as-code publishing and workflows, conceptual topics, tutorials, API documentation jobs, and more.
Example domain paragraphs
–AI chat interfaces could become the primary user interface that people use to read documentation, not documentation websites themselves. –AI chats will enable novices to tackle more advanced tasks, leading to an explosion of technical innovation. –Documentation will provide the information source that AI chat engines need to respond to queries. –Both tech writers and machines will write the information source.
In this episode, I chat with Dan Grabski, a senior content developer based in Portland, both about his recent WTD talk titled 'Zen and the Art of Manually Creating API Documentation' and Robert Pirsig's 'Zen and the Art of Motorcycle Maintenance.' Dan explains the importance of focusing not just on technical details of implementations but also on integrating the people side — on understanding the perspectives of different users and stakeholders involved. Dan provides examples from his engineering background
I'm giving a webinar titled 'Experiments and use cases for AI from a tech writer’s perspective' on December 8, 2023. The webinar is sponsored by the STC Washington, DC - Baltimore Chapter. In this presentation, I’ll share some personal experiences in using AI for different writing-related use cases, explaining what I’ve found helpful. These use cases and takeaways are all experiential, based on my experiments with using AI both in the workplace for documentation-related scenarios and writing on my blog.
Ye Olde Blogroll - Blogroll.org