'Good documentation is a tell-tale sign of a great product and a company that puts users first. There exist good products with bad or no documentation, but there are very few poor products with great documentation.'
--John Gruber, https://daringfireball.net/linked/2026/05/12/kagi-snaps
I'm streaming KDE docs:
I'm streaming to both Owncast and Twitch right now.
Today I'll practice plasmoid development.
Be sure to join and ask any questions related to KDE and I'll try my best to answer them.
Every single stream I do is an Ask Me Anything KDE Edition β’οΈ
@kde #KDE #Linux #Documentation #TechnicalWriting #FurryStreamer #FurryVTuber #VTuber #Owncast #Rust #Twitch
I'm a hare pretending I'm a human pretending I know C++ and CMake π°
The introduction of Claude Code in my technical writing workflow has drastically shifted the main bottleneck. It used to be during the exploration and discovery phase, either on my own or with the help of an SME. Now that Claude Code assists in that phase, all my documentation requests reach the final review stage much faster. This means more requests reach the final review stage for SMEs, who are struggling to keep up. When the SME is a developer, it adds to their workload, especially with the increase in code reviews as other developers also produce more. These are interesting times.
I would love to see more technical articles and books written with the same level of clarity.
"Index 1,600,000,000 Keys with Automata and Rust" (2015) by Andrew Gallant.
https://burntsushi.net/transducers/
#article #rustlang #TechnicalWriting #automaton #datastructures #algorithms
Food for thought: When documenting the behavior of a highly customizable and configurable product or feature based on questions from a single customer, a technical writer should always consider the scope of the final documentation artifact. This requires making a clear distinction between what is specific to that customer and what is generalizable and easily reproducible by all.
If we don't enforce that strict separation, we run the risk of transforming the artifact into a laundry list of uncontextualized items that are mostly unintelligible for the other customers. In those cases involving very specific scenarios, sometimes what the customer really needs is not necessarily more documentation but rather a detailed technical conversation from our engineering team with their developers explaining how they can by themselves find answers for those questions whenever they need them :)
"Back in 2024 I wrote that AI helps me remove boring work at the margins. This is fine for a lone writer, but how to scale this to an entire team of technical writers? How to make the system helpful but not intrusive? These are all questions Iβm starting to answer now, partly through experimentation, but also through dialogue with practitioners and colleagues. One answer Iβm testing these days relies on GitHub Agentic Workflows.
Following Four modes of AI-augmented technical writing, I thought of a way of distributing tooling effort across all modes through a tiered system where each level holds a different relationship with the writer. The result is four tiers: intake, local assistance, automated governance, and an MCP server that provides reliable knowledge to all. The idea is that AI assists the writer not just while writing, but also before and after they work on docs."
https://passo.uno/agentic-workflows-for-docs/
#TechnicalWriting #AI #GenerativeAI #LLMs #AIAgents #AgenticAI #AgenticWorkflows #SoftwareDocumentation #GitHub #DocsAsCode
Back in 2024 I wrote that AI helps me remove boring work at the margins. This is fine for a lone writer, but how to scale this to an entire team of technical writers? How to make the system helpful but not intrusive? These are all questions Iβm starting to answer now, partly through experimentation, but also through dialogue with practitioners and colleagues. One answer Iβm testing these days relies on GitHub Agentic Workflows.
The Assignment That Tells Hiring Managers Nothing New
κΈ°μ μκ° μ±μ© κ³Όμ μμ λ€μμ μΈν°λ·° νμ μΆκ°λ‘ μꡬλλ κΈμ°κΈ° κ³Όμ λ μ΄λ―Έ μΈν°λ·°μμ νμΈλ μλμ μ€λ³΅ νκ°νλ κ²½μ°κ° λ§μ ν보μμ κΈ°μ λͺ¨λμκ² λΉν¨μ¨μ μ λλ€. νΉν AI λꡬλ₯Ό νμ©ν λΆμ νμκ° μ¦κ°νλ©΄μ κ³Όμ μ μ λ’°μ±μ΄ λ¨μ΄μ§κ³ μμ΅λλ€. λμ ν보μκ° μ€μ μμ±ν ν¬νΈν΄λ¦¬μ€λ₯Ό λ©΄μ μμ μ§μ μ€λͺ νκ³ ν λ‘ νλ λ°©μμ΄ λ ν¨κ³Όμ μ΄λ©°, AIλ‘ λ체νκΈ° μ΄λ €μ΄ μ§μ ν μλμ νκ°ν μ μμ΅λλ€. μ±μ© λ΄λΉμλ ν보μμ μκ°μ μ‘΄μ€νκ³ μ€μ§μ μΈ λνμ μ§μ€νλ μ±μ© λ°©μμ κ³ λ €ν΄μΌ ν©λλ€.
https://stevearrants.substack.com/p/the-assignment-that-tells-hiring
Niklas Pivic
herz (π₯){π}
Mr Cheseaux
HackerNoon
yugaego π
Miguel Afonso Caetano
Vermonter
sayzard