What I'm Reading

Documentation review checklist

August 22nd, 2009

I'm looking to improve our documentation review process and I came across this review checklist from Purdue University's Technical Writing course. It incredibly thorough and not something I'd send out to developers, product managers etc when asking them to review documentation, but it's a very useful reminder for tech writers conducting peer review of a fellow writer's work.

Leave a comment

 

Documentation review

August 19th, 2009

Tips for managing the technical documentation tech review. Some useful ideas for getting your documentation reviewed effectively.

Leave a comment



Microsoft Word in one page

August 11th, 2009

Microsoft Word in one page - a useful quick lookup resource for Word. Particularly useful for the list of keyboard shortcuts further down the page.

Leave a comment



Discovering Relationship Tables | I’d Rather Be Writing

August 4th, 2009

Discovering Relationship Tables - Tom Johnson. A fascinating Flare tip on how to steer users towards the help they're looking for more effectively in context-sensitive help.

Leave a comment



5 Ways to Make Executives Love the Publications Department

July 7th, 2009

THE CONTENT POOL: 5 Ways to Make Executives Love the Publications Department. Alan J. Porter writes:  If you go around say “I’m only a tech writer,” or “publications never gets any respect,” then people will believe you and act accordingly. Be aware of what you do, what you can offer and be proud of it. Treat your team (even if it’s only you) as if it was your own business. Build brand awareness, market and promote what you have to offer, and sell yourself, your team and the profession.

Leave a comment



^ back to top ^

Page 2 of 3«123»