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.
Subject:Storyboarding for an Established Application From:Anthony <italian_scribbles -at- yahoo -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Sun, 8 Feb 2009 16:37:12 -0800 (PST)
Hello Everyone,
I have the oddest situation at my workplace and would like to get some input.
Late last week my boss asked me to storyboard an internally developed piece of software that essentially tracks and captures the details of technical issues worked by one of our technical teams. Essentially a trouble ticket system similar to those used by help desks. The application uses a web based GUI.
The oddest part is that the application has already been launched and has been in active use since October of last year. A user manual has already been published, but is outdated and the storyboards are not intended to be used to update the manual. In fact, the manual is going to be replaced by a pop-up type of help that will explain most of the individual fields, screens, menus, buttons, etc. in the system.
In qualifying this project I found that there is no desire for highly technical UML diagrams or the like that I have done in the past. The resulting storyboards are to be used by the users and the assigned programmers who code upgrades and correct bugs in the system. It is to give everyone a better understanding of the system.
My thinking is that we need some very narrowly defined use cases as well, but I am unsure.
Has anyone else run into such an odd situation?
What details would you include and exclude in the storyboarding process?
It is a first for me in my many years of software development and documentation.
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
