Take the 2-minute tour ×
Writers Stack Exchange is a question and answer site for authors, editors, reviewers, professional writers, and aspiring writers. It's 100% free, no registration required.

I've been asked to modernize some technical documentation - user manuals in particular. I have some guidelines, but a lot of free rein to take it in whatever direction I think is worthwhile. Where can I look to learn what exactly is a good example of "modern" technical documentation? I'm interested in resources such as websites that describe best practices as well as resources for learning state-of-the-art tools.

I am interested in tools and specifically information on layout and organization.

share|improve this question
    
@JohnSmithers - does the edit help? –  justkt Jul 25 '12 at 13:14
    
Please excuse me if I misunderstand your question. But regarding tools and layout - have you had a look at LaTeX? Sure, it's been around for a while, but still very powerful when it comes to scientific writing. Might I ask which kind of user manuals you mean? Like, do you need program listings or many mathematic formulas or chemical formulas and so on. –  Philipp Grassl Aug 20 '12 at 20:26
1  
You may want to clarify what is meant by "modern." Are you supposed to be converting print manuals to IETMs or to a help system? I know the Society for Technical Communication has an annual contest for documentation. Contest winners might be good examples. Reading a few recent issues might also be a good overview of best practices. –  Kelly Tessena Keck Sep 7 '12 at 20:13
    
@KellyTessenaKeck - I am making manuals that are digital at least somewhat more IETM-like. Thanks for the excellent suggestion on the documentation contest winners. –  justkt Sep 9 '12 at 23:20
add comment

1 Answer

up vote 3 down vote accepted

There are a few tech writing blogs and forums that I like. Joining STC is useful, though it costs $195 a year ($160 if you graduated within the last three years). Membership includes access to both their publications. Intercom has a lot of best practices articles and information about new tools, while Technical Communications is their academic journal.

I'd Rather Be Writing - a blog about the latest trends in tech writing: http://idratherbewriting.com/

The Content Wrangler - a blog and community about managing content as a business asset http://thecontentwrangler.com/

E-mail lists or forums might be another good way to get information. TechWr-L (http://www.techwr-l.com/) is a good group with lots of knowledgeable people. You might find some good information going back through their archives with keywords like "IETM" or the names of specific tools you want to learn more about.

share|improve this answer
add comment

protected by Neil Fein Sep 17 '12 at 22:23

Thank you for your interest in this question. Because it has attracted low-quality answers, posting an answer now requires 10 reputation on this site.

Would you like to answer one of these unanswered questions instead?

Not the answer you're looking for? Browse other questions tagged or ask your own question.