TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
> I think the best examples of technical documentation I have ever seen are
> the instructions that come w/ modern-day Lego kits. They are entirely
The only problem with calling this "best documentation" is that it does not
solve a particularly hard problem. It just shows how to fit pieces together.
Sure, pictures work fine for this. Ikea's documentation generally works well
for the same reason. But there are no concepts to be mastered here. There
are no conditions to assess. No interactions with an external environment to
manage. Not even any tools required. Physical assembly of well designed
components just isn't much of a challenge to do or to document.
"Best documentation" should be saved for documentation that solves a harder