'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

#TechnicalWriting #documentation

I'm streaming KDE docs:

• right now!
• on https://live.rabbitictranslator.com
• on https://twitch.tv/herzenschein

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

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.

#TechnicalWriting #AI #Workflow

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 :)

#TechnicalWriting #Documentation #SoftwarDocumentation

"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

The Assignment That Tells Hiring Managers Nothing New

기술 작가 채용 과정에서 다수의 인터뷰 후에 추가로 요구되는 글쓰기 과제는 이미 인터뷰에서 확인된 역량을 중복 평가하는 경우가 많아 후보자와 기업 모두에게 비효율적입니다. 특히 AI 도구를 활용한 부정행위가 증가하면서 과제의 신뢰성이 떨어지고 있습니다. 대신 후보자가 실제 작성한 포트폴리오를 면접에서 직접 설명하고 토론하는 방식이 더 효과적이며, AI로 대체하기 어려운 진정한 역량을 평가할 수 있습니다. 채용 담당자는 후보자의 시간을 존중하고 실질적인 대화에 집중하는 채용 방식을 고려해야 합니다.

https://stevearrants.substack.com/p/the-assignment-that-tells-hiring

#technicalwriting #hiring #ai #assessment #portfolio