A few weeks ago I mentioned Alphadoc, a new tool for publishing API documentation. The following is a Q&A with Daan Stolk, cofounder/CPO of Alphadoc. In the following questions, Daan tells the story behind Alphadoc and what makes it unique from other API documentation tools.
Providing summaries of content is one of the most useful and powerful capabilities of AI chatbots powered by large language models (LLMs), like ChatGPT, Bard, and Claude. As such, AI chatbots can significantly help tech writers in a variety of documentation-related tasks, such as generating summaries at the top of each document, generating product overviews that summarize features and capabilities, and helping tech writers process content more quickly from long articles, bugs, meetings, and other documents.
Here are a few links from around the web worth reading for September 5, 2023.
Compiling and maintaining glossaries can be time consuming. Can AI tools help with glossaries? Just as AIs are good at creating summaries, providing definitions might be one of AI's strengths. A definition is just a short summary of a concept. AI tools are also good at identifying potentially unfamiliar, jargon-filled terms and then listing concise definitions for them.
The best scenarios to implement AI are those tasks that humans perform poorly but robots perform excellently. One of these task domains is comparative analysis, specifically comparing two sets of information to identify inconsistencies. API responses can be complex, with a wide variety of fields that can be returned depending on the request. As humans, it can be hard to compare large amounts of text quickly, but AI tools might be good at this task.
One of the main ways I use AI is with thematic analysis, which involves identifying, analyzing, and reporting patterns (themes) within qualitative data. After you identify major themes, you can use least-to-most prompting techniques to go into more detail. I recently used this technique in preparing notes for a book club. It could also could work well for a number of documentation-related scenarios. In this article, I explore using AI for thematic analysis with doc feedback, search analytics, tags and related pages, FAQs, glossary items, bugs, and documentation pages.
I added a new article to my API doc course on using AI for language advice. When you have questions about style, grammar, or other syntax, try asking your favorite AI tool. AI tools can do an excellent job at identifying the particular grammar or style rule or reason, and they can provide guidance about why one phrasing is preferable to another. In asserting a preference, AI will often make a convincing argument for one style over another, such as noting that a word could be interpreted in different ways and so is more ambiguous than the other phrasing.
I added a new article to my API course about using AI to create doc updates based on bugs. By bugs, I'm referring to small issues often surfaced by users about the docs. Bugs are often long lists of random fixes to make with the docs, often involving a small number of changed lines. However, interpreting the bugs can be challenging. Fortunately, AI tools can help you understand the issue and resolution.
I added a new AI topic to my API doc course: Using AI to learn coding. One challenge API technical writers face is understanding developer code and tools. This is by far the most intimidating aspect of being an API technical writer. As if documenting code for one project weren't enough, API technical writers must also support multiple projects simultaneously, often with different types of code. You might document a Java API for one project, a REST API for another project, some Go code for an SDK, some C++ code for another project, and so on. It can be nearly impossible to be fluent in all of these languages. Fortunately, you can use AI tools to learn code more efficiently. AI tools can act like a friendly programming buddy who is sitting next to you, ready to explain anything you want, at whatever technical level you need. You can zero in on a specific question or broaden it out to increase your understanding from ground zero.
I added a new article to my API doc course about using AI tools to write scripts. At the core of API documentation work is building, staging, and publishing of API reference content. Whether it’s Javadoc, Doxygen, OpenAPI, or other reference output, almost every API has reference documentation that you build, stage, and publish with each release. Given the centrality of documentation building and publishing tasks, AI tools can be a great help when it comes to configuring scripts to perform these tasks. This is one AI area few people are focusing on, but scripts are an easy way to incorporate AI to improve your productivity and reduce the tediousness of document production.
I added a new section to my API doc course on pattern-based prompts. Pattern prompting involves teaching the AI a specific structure or template, then having it populate information into that template. Pattern prompts are similar to few-shot prompts, but in this case, rather than having the language model populate the template with its own information, we’ll have it sort and structure a mess of information into the template, thus reducing hallucination and error.
I added a new topic to my API doc course on the Oxygen XML Positron Assistant. Positron lets you use AI tools inside Oxygen XML to help with a variety of writing tasks, such as writing short description elements, correcting grammar, improving readability, adding index terms, and more. Positron hooks into an AI provider (currently ChatGPT 3.5) to pass your topic content to the AI with a specific instruction. It then returns the content and allows you to preview the diff, seeing what has changed and inserting the modified text in place. By integrating directly with your project, Positron helps you use AI when and where you need it, without switching contexts or resorting to external tools.
I'm adding a new section on AI to my API doc course. Currently, there are just two articles in there (one on Oxygen XML's Positron Assistant, another on AI document engineering) but I plan to add many more over the coming months.
The Oxygen XML Positron Assistant lets you use AI tools inside Oxygen XML to help with a variety of writing tasks, such as writing short description elements, correcting grammar, improving readability, adding index terms, and more. Positron hooks into an AI provider (currently ChatGPT 3.5) to pass your topic content to the AI with a specific instruction. It then returns the content and allows you to preview the diff, seeing what has changed and inserting the modified text in place. By integrating directly with your project, Positron helps you use AI when and where you need it, without switching contexts or resorting to external tools.
One of the classic stories that is told in our profession is how and why we got into technical writing. The story is usually one of unintended directions and decisions, in which someone initially intends to pursue one career, makes a series of adjusting decisions and course corrections, and finally ends up writing docs as a tech writer. Because so few people actually set out to become tech writers, the story is usually interesting to listen to...
