RtFM (When All Else Fails) by Domenika Marzione [documentation]
Technical writing, to paraphrase Daniel Patrick Moynihan, is all about defining common sense down. On the surface, it's all about writing out directions. But tech writers know that the real job is coming up with the myriad ways someone can screw up the task and then telling them explicitly how not to do it that way. Just in nicer language.
Codifying existing practices takes that theory and turns it into object lessons -- every explicit instruction has a basis in fact, not imagination. You're not telling folks not to do something, you're telling them not to do it again.
Remember -- it wouldn't be in there if someone hadn't tried it first.
RtFM (When All Else Fails)
Genfic, rated PG (for Pure Guano).
GPM 003 -- Encountering New Artifacts HTML | LJ
ATLPM 010 -- Cataloging New Artifacts HTML | LJ
With a tiny fist raised in solidarity with all those who know that the more educated the intended audience, the smaller the words you have to use. Thanks to aliciam and smittywing for following along.
Codifying existing practices takes that theory and turns it into object lessons -- every explicit instruction has a basis in fact, not imagination. You're not telling folks not to do something, you're telling them not to do it again.
Remember -- it wouldn't be in there if someone hadn't tried it first.
RtFM (When All Else Fails)
Genfic, rated PG (for Pure Guano).
GPM 003 -- Encountering New Artifacts HTML | LJ
ATLPM 010 -- Cataloging New Artifacts HTML | LJ
With a tiny fist raised in solidarity with all those who know that the more educated the intended audience, the smaller the words you have to use. Thanks to aliciam and smittywing for following along.