Prompt engineering series: Creating scripts to automate doc build processes
Documentation scripts perform processes such as building reference documentation or doing other repeated processes with docs. This tutorial builds on the conceptual content in Use cases for AI: Develop build and publishing scripts. In this tutorial, I get more specific with strategies and techniques for prompts, walking through a prompt to build a doc script for generating reference docs. Read more »
What should your documentation metrics look like? Q&A with Zoomin about their 2024 Technical Content Benchmark Report
Zoomin recently released a Technical Content Benchmark Report for 2024. This report explains the company's second benchmark report on documentation metrics, which analyzes data from 97.6 million user sessions across 136 countries. The report provides insights into average metrics like page views, bounce rates, time on page, GPT search usage, and more. In this Q&A with Rita Khait from Zoomin, she discusses how to interpret and use these benchmarks to set goals, improve content findability and performance, and demonstrate documentation's value to stakeholders and the business. Read more »
AI is accelerating my technical writing output, and other observations
At the start of the year, I wrote a trends post and noted uncertainty about the directions AI will take tech writers this year. (See My 2024 technical writing trends and predictions.) Now that we're into April, I have a better sense of how things are going and wanted to provide an update here. My main observation is that AI is accelerating my technical writing output, making me about twice as productive as before. Also noted in this post: prompt engineering is a non-obvious skill that many tech writers still struggle with, even though documentation is more within AI's sights than creative content. Read more »
Upcoming conference: AI the API docs
There's an upcoming conference called AI The Docs 2024: API Documentation and AI Best Practices, held April 3, 2024 online. The conference is put on by the same API the Docs group / Pronovix that holds other online conferences and events. I'll be one of the speakers. I'm planning to talk about prompt engineering. Read more »
|