From passo.uno
The Seven-Action Documentation model
13 13
I think all technical writers, at some point or another, feel the urge to base their work on something more systematic than “it’s just the way folks documented stuff since forever”. Toolkits and frameworks provide content types, which is immensely valuable when you know what you want to write,...
#ux #MLOps #teaching #education #uxresearch #cseducation #datascience #programming #ycombinator #技術文檔
on Thu, 1PM
From passo.uno
My technical writing predictions for 2025
0 0
For the first time since I started this blog, I’m writing some predictions on software technical writing for next year. Not because I think they’ll be accurate—they never are—but because the exercise reveals what we’re concerned about and what we hope to tackle. Predictions are to-do lists in...
on Dec 27
From passo.uno
What I say when someone asks me what are my favorite docs
0 0
I’m a terrible user of documentation. I tend to consume docs in a hurry, reading diagonally, Control+Fing my way to things. I generally mistreat the interface of docs until I obtain something resembling an answer. I do this because I’ve little time and I need to fix issues fast. I love examples...
on Dec 15
From passo.uno
0 0
Everybody loves to hate Frequently Asked Questions, or FAQs. More often than not, technical writers pale and stagger at the sight of hefty, unsorted FAQs, as if they were beholding a writhing mass of primal chaos. Others value their pragmatic qualities: FAQs, they say, lower the bar to...
on Nov 30
From passo.uno
Why I became a Documentation Engineer (and what that even means)
0 0
A reader asked me how they’d become a Documentation Engineer, because they saw I got hired as one and felt curious about what it takes to get there. This inevitably got me thinking about job titles and the evolution of tech writing, two topics that are quite central to this blog. Let me begin...
on Nov 24
From passo.uno
Docs observability, or measuring docs inside a product-docs system
0 0
on Jan 8, 2024