“Fortunately, I think there’s a good alternative to the dismal picture of brain-dead tech writers pressing buttons on AI machines and passing the content to SMEs for review. That alternative is to focus on what AI algorithms can’t do (at least not with a few button clicks). In this revised approach, tech writers offload the simple tasks to AI tools to fix while focusing their real time and energy on more complex, ambitious tasks that are beyond the straightforward capabilities of AI tools.
When I say beyond AI capabilities, I still mean AI tools might assist or augment tech writers in the work; it’s just that the tasks aren’t as simple as the mechanical tasks of fixing doc bugs that I described earlier (e.g., “what’s the issue? what’s the fix?”).
For example, when I set about creating complex tree diagrams showing all elements in an API, this was a new kind of documentation that hadn’t been done before at my company. It became an instant hit and one that proved challenging to maintain and grow and fix, but still worthwhile. (In fact, in a chat with a product manager last week, he wondered if our tree diagram page wasn’t the most popular page in our documentation.)
If we focused more on these sophisticated tasks (beyond click-button AI), I think tech writers could have a brighter future.”
https://idratherbewriting.com/blog/recursive-self-improvement-complex-tasks
I’ve been playing around with Codapi. It lets you make interactive code examples in your docs, blog, etc.
Instead of just reading, readers can play around with them—making learning way more fun and hands-on!
Great work! @antonz
Had a very interesting reflection about #codemods this week. How to put the cursor between do and document, and documenting really helps structuring your thought.
Using GitHub Copilot code review - Now in VS Code!
https://docs.github.com/en/copilot/using-github-copilot/code-review/using-copilot-code-review?tool=vscode
#codereviews #ai #githubcopilot #vscode #aiassistant #docs
Using GitHub Copilot code revi...