|
|
|
|
|
by humanrebar
2362 days ago
|
|
Specs, reference docs, how-tos, tutorials, and explanations are all different types of documentation. They have different tones, amounts of detail, structures, and purposes. It's impossible to do all of the above in one document except in trivial cases. So at the risk of having opinions that overreach the context I was given here, I'll argue that the materials were not "perfect", no matter how thorough. In fact, I think it's possible to edit what you wrote a little and make the word "perfect" ironic. If someone is making colleagues emotional, that's a red flag that the approach to documentation leaves room for improvement, for instance. Good writing requires empathy for the audience. |
|