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.
Re: Software documentation that uses effective visual metaphors?
Subject:Re: Software documentation that uses effective visual metaphors? From:Ryan Young <ryangyoung -at- gmail -dot- com> To:Lois Patterson <loisrpatterson -at- gmail -dot- com> Date:Wed, 6 Aug 2014 14:23:10 -0700
Depending on what you're trying to explain, UML (Unified Modeling Language)
might be worth looking into. It can help explain complex processes in some
detail. I've been using it to describe create diagrams that show the behind
the scenes workflow for various user tasks (i.e., what happens in the data
center after a user clicks a button. The amount of information it allows
you to represent is impressive.
On Tue, Aug 5, 2014 at 5:16 PM, Lois Patterson <loisrpatterson -at- gmail -dot- com>
wrote:
> Does anyone know of software documentation that uses effective visual
> metaphors to describe the processes that the software performs? Clearly,
> lots of software documentation is visually attractive. But I am looking
> specifically for visual metaphors and analogies.
>
>
> Lois
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Read about how Georgia System Operation Corporation improved teamwork,
> communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as ryangyoung -at- gmail -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwhirl.com/email-discussion-groups/ for more resources and
> info.
>
> Looking for articles on Technical Communications? Head over to our online
> magazine at http://techwhirl.com
>
> Looking for the archived Techwr-l email discussions? Search our public
> email archives @ http://techwr-l.com/archives
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Read about how Georgia System Operation Corporation improved teamwork, communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l