I'm a visual learner, so I like the idea of seeing a screenshot or
explanatory graphic, but my company's guidelines state that graphics
are strongly discouraged in documentation. From our
standards/guidelines documentation, here's (paraphrased) what they
say:
- Graphics, when used, should be used to explain complex concepts.
Ensure that you have textual descriptions as well.
- Do not use screenshots except in the Getting started section of
documents. Use screenshots sparingly in other situations.
- Take these factors into account:
- Screenshots cannot be translated
- Screens change during development and translation
- Including/updating screenshots can be complicated/time-consuming
- System customization can make screens deviate from a standard
release system
- Screenshots can take up more memory and storage space
Our standards really caution against using screenshots, but allows for
them if there's truly no other way to relay the concept. As far as,
say, process flow diagrams and that sort of thing, again, those are
only allowed to help explain a complex concept.
As far as why this makes sense at my company, I work for a large
international company whose products are translated into many
languages. Having to remove/replace screenshots for new language
releases would be time- and cost-prohibitive.
On 12/21/06, Thomas Johnson <[EMAIL PROTECTED]> wrote:
> Hi Gary,
>
> For the life of me, I can't see why anyone would want to do such a thing.
> I'd sure like to hear the rationale as well.
______________________________________________
Author Help files and create printed documentation with Doc-To-Help.
New release adds Team Authoring Support, enhanced Web-based help
technology and PDF output. Learn more at www.doctohelp.com/tcp.
Are you a Help Authoring Trainer or Consultant? Let clients find you at
www.HAT.Matrix.com, the searchable HAT database based on Char James-Tanny's HAT
Comparison Matrix. Contact [EMAIL PROTECTED] for details.
_______________________________________________
Technical Communication Professionals
Post a message to the list: email [EMAIL PROTECTED]
Subscribe, unsubscribe, archives, account options, list info:
http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com
Subscribe (email): send a blank message to [EMAIL PROTECTED]
Unsubscribe (email): send a blank message to [EMAIL PROTECTED]
Need help? Contact [EMAIL PROTECTED]
Get the TCP whole experience! http://www.techcommpros.com
