Prompt engineering for tech comm
- Overview
- Task decomposition and complex tree diagrams
- Creating high-fidelity, thematically organized notes from engineering meetings using AI
- Populating documentation templates using AI
- Reverse engineering the recipe for excellent documentation
- Gathering source material for context input
- Error checking the AI output
- Creating scripts to automate doc build processes
- Using file diffs for better release notes in reference docs
- Automate links in your release notes using AI
- Using long-token contexts to quality check an entire API doc set
- Using AI to jump-start code samples
- From engineer interviews to written draft, with chain of thought reasoning
- Using AI to design landing pages
- Using AI to mine log messages from reference doc builds
- Using AI with issue tracking systems
- API quick reference guides
Lesson 1 of 17
Prompt engineering refers to crafting prompts in a way that yields the result you want. Although prompt engineering techniques are fairly intuitive, few people have meticulously applied prompt engineering techniques to scenarios involving tech writers writing documentation.
Continue to the next topic: Task decomposition and complex tree diagrams
About Tom Johnson
I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.
If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.