A year of working with AI feels like five years of regular thinking. Is that true for you too, or is that just me?
I’ve spent the past year integrating AI into my API documentation course.
- Feb 2024: Start experimenting with use cases
- April 2024: Teach the last non-AI version of the course
- July 2024: Formal lesson planning updates
- Sept 2024: First AI-enhanced term
- Dec 2024: Reflect and revise
- Feb 2025: Prep for next iteration
So, the AI component of API documentation has been swirling around in my head for at least a year now. Here’s what that year of experimentation revealed.
Three categories of AI in technical writing
Last summer, I drafted three categories for thinking about AI interaction in technical writing:
- AI supporting content creation and management – Tools that help you write, edit, organize, and maintain documentation
- AI generating and publishing content – Tools that create documentation with minimal human intervention
- AI reading your content – How AI tools consume and use your documentation in other contexts
I’ve tested all three in the course. Here’s what I’m learning about each.
Category 1: AI supporting content
Students in the last term were encouraged to experiment with their AI assistant throughout the course. They discovered where it helped and where it didn’t—sometimes intentionally, sometimes by accident.
For next term, I’m making this discovery more structured. Students will systematically test their AI tool on specific tasks: outlining topics, reviewing their drafts, explaining concepts they’re documenting, generating test cases for code examples.
The challenge: AI still has no user guide. AI tools don’t document their own limitations. Students need to test them systematically on specific tasks to discover where they help and where they fail. That’s what we’ll work on next term.
Category 2: AI generating content
I’m still skeptical about unmonitored AI content generation. I’m watching my opinion on this closely because I suspect I’ll need to reconsider it soon. For now, I don’t think AI is ready for write access to the repo.
Continue reading “Teaching AI in Tech Writing: One Year In”
