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.
I have been tasked to write a new version of existing API docs.
The audience for this new document is both technical and very
non-technical. The API is a .NET web services (asmx files). My idea is to
create a very basic, simple, introductory concept chapter and include
simple graphics (and maybe a work flow doc) to explain what an API does and
how the two parts of this one work.
I am writing in Word, converted to pdf and the document is used both online
and hard copy. I can think of some innovative ways to use bookmarks and
links in Word for the online users but what I'm really after is using the
graphics to convey how the API works.
I wonder if anyone on the list has used graphics or seen really good
example of using graphics to explain a work flow. Work flow diagrams are
fine, but really non-technical users need simple line art (IMHO). I'm
asking if anyone can point me to some of their favorite "graphics
explaining how something works" so I could learn by example and/or get my
creative juices flowing.
Any suggestions appreciated. No time to plan to use other types of docs,
etc.
Thank you.
Bobbi
--
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help. Choose your authoring formats and get any output you may need.
Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.
