←back to thread

Focus on decisions, not tasks

(technicalwriting.dev)
293 points kaycebasques | 1 comments | | HN request time: 0s | source
Show context
johnathandos ◴[] No.41886038[source]
Thanks for sharing. A couple of thoughts.

It seems like it's a lot harder to measure whether your docs are helping people make good decisions than it is to measure whether they are helping people successfully accomplish a task. I think we optimize for task-based/procedural docs because the business needs us to prove our value, and there is a need for this type of documentation, and there are lots of ways to measure and report on it over short timelines. But answering the question of, "Did this docset help someone build the right thing in the right way", I mean...organizations struggle to answer this question about their own products, abstracting that to try and measure the effectiveness of your docs seems super fuzzy.

Which is not to say you can't write docs that do this, just that it seems very hard to use numbers to prove that you have done so. I definitely think I could rank how well different docsets support users who need to make decisions, and I could offer up explanations to support my reasoning, but I don't know how to quantify that for the business.

I wonder how the structure of a docset that is designed to support decisions differs from that of a docset that supports tasks. I expect you'll have the same main categories (conceptual, reference, guides) but maybe a lot more conceptual docs, and more space dedicated to contextualizing the concepts. I would expect to see topics become more interdependent, more cross-references, etc.

replies(2): >>41886315 #>>41888149 #
auggierose ◴[] No.41886315[source]
Interesting that your first thought here is not, oh, how can I use this to improve the docs I am writing, but it is, how can I prove that this improves the docs I am writing. You seem to live in a though environment.
replies(2): >>41887944 #>>41888269 #
johnathandos ◴[] No.41888269[source]
You're not wrong. Business is a tough environment.

At a gut level the post seems sensible to me, and it does generate a lot of ideas about how I can make my own docs better. That's not enough, though, if I want the folks who think about docs at my org to change their approach.

As the OP states in several other comments, most writers and organizations learn to prioritize task-based documentation. If we want to adopt a better way of doing things, we need to be able to communicate why it's better. It's no different in other disciplines.

replies(1): >>41888719 #
1. gtirloni ◴[] No.41888719[source]
Exactly. Or you become an island doing the good but sometimes barely scratching the surface of what could be possible (to the detriment of your users).

Another aspect of this is that it may take you more time to complete your assignments and you get labeled as slow.