Get the latest tech news
The Seven-Action Documentation Model
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, but starting from there is like buying a hammer without knowing that half of the work you’ll do is turning screws. As I find the lack of deeper conversation around this topic rather unsettling, I decided to contribute some verses.
Such an approach is fully compatible with documentation frameworks like Diataxis, DITA, and others, as it provides direction and purpose to the builders of docs, who’ll then use content types, elements, and tools at their disposal. While docs created to fulfill other actions may be read once and internalized, reference material remains perpetually valuable as users deepen their expertise and tackle increasingly sophisticated implementations. A DITA task topic, for instance, maintains its structural integrity as a procedure while potentially helping users practice a workflow, remember key parameters, and anticipate common issues.
Or read this on Hacker News