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.
Subject:RE: Self-promo in dangerous times From:"John Posada" <writer -at- tdandw -dot- com> To:"List: TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 29 Jan 2004 21:41:25 -0500
>> And for those who shy away from such acts, I
>> can only say TRY IT.
>
>Don't use master documents unless you are Steve
>Hudson. And don't do self-promotion unless you
>are John P. :-)
Thanks, Mike.
However, seriously...
If you look at the examples I gave, the actions aren't
anything that most of us aren't doing every day already (I
HOPE!). Meeting deadlines, helping work-peers, making
suggestions for better documentation, etc.
The only difference is that some people hide in their
cubes/offices, pound away on the documentation, and even
when they do something absolutely superb, nobody knows. Why?
Because nobody was told.
Who hasn't sent the following type of email to their
immediate manager:
=============================================
Thank you VERY much. I looked through them, I don't see any
issues with getting them into the document for tomorrow.
BTW.once we get breathing room, maybe for the next release,
I'd like to suggest that we create a third document and
fourth document; System Admin and Command Guide. In the
Admin, we could include all of the advanced stuff, including
all the DIAG stuff, the PEL stuff, etc., and for the Command
Guide, as David W suggested to me, a Trifold, or a booklet
as a reminder with all the commands and @LIST stuff. I think
it would also allow us to go deeper into some of the more
obscure stuff in greater depth.
We'd then have four documents;
Installation Guide
User Guide
Admin Guide
Command Guide
I think it would also align with some of our other stuff
where we separate admin from regular user.
It's just a suggestion.
==============================================
If you haven't, and you call yourself a SENIOR technical
writer, shame on you :-)
Here's two differences:
1) Some stop at the first line...they are telling the
Reviewer that they received the changes and they will be in
the document on time.
2) Some, even if they offer that suggestion, ONLY send it to
their immediate manager, who sees it as "you're making more
work for us." and it goes no further. Why not also send it
to the Product Manager, who wants everything, including
documentation, to be better all the time.
It's simply letting others know what you are doing and that
you have suggestions.
I used to have a sig: "The key to having a happy boss:
Commit to 5% more than required, then deliver 5% more than
committed.