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.
>
> 1. Make the documents look professional - if it looks 'good' it's
> more likely to be read, or at least looked at. Bit like wearing a suit
> to an interview - first impressions DO count!
I would add to this that a good document format has to be consistent
throughout, so that there are visual clues as to the nature and purpose of
each element - e.g. all headings of a particular level need to look the
same, second level headings need to be distinguished from first-level, all
notes have the same format, bullet lists are consistent throughout etc, so
that the user isn't distracted by oddities in the format when trying to get
at the content.
A good format should cease to be noticed after a short time reading the
document.
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-