3 ms·
The “atomization” issue is one of my biggest bugbears, which I often comment on here. If your project's documentation is a website with many small documents all
by vincent-manis 1y ago
The “atomization” issue is one of my biggest bugbears, which I often comment on here. If your project's documentation is a website with many small documents all linked together in multiple ways, don't expect me to spend time trying to sort it all out. I recognize that some people are hyperlink-happy, but my way of learning was influenced by an obsolete technology called “books”[1], which provide a linear path, so later topics can build on earlier ones. This is very basic pedagogy, which so many documentation practices ignore.
[1] “When I was your age, television was called books.” The Princess Bride
- scrubs 1y agoAgree! Definitely. Always. All day long, and twice on Sunday. Effective communication is both about the parts (details) ---AND--- composing the parts into an integrated whole. You gotta have both. So don't screw it up by lapsing into atomic incremental update mode where I fix this one ticket, an error, of tell you about some new bit of info then communicate it by writing a new page cross-linking other stuff. Integrate the update.