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: Getting up to speed on UML (Was: Re: Documentation Correctness...)
Subject:Re: Getting up to speed on UML (Was: Re: Documentation Correctness...) From:John Posada <jposada01 -at- yahoo -dot- com> To:Stuart Burnfield <slb -at- westnet -dot- com -dot- au>, techwr-l -at- lists -dot- techwr-l -dot- com Date:Tue, 23 Oct 2007 06:42:45 -0700 (PDT)
> I'll be working on an existing system that is a
> bit light on for design docs. I won't be doing
> the analysis but I need to be able to read and
> maintain existing UML diagrams while updating
> the end user docs, sitting in on design meetings, etc.
>
> John (or anyone), can you recommend any other good
> resources to bring me up to date on UML? The client is
> aware that I'll need to learn on the job, but the better
> prepared I am, the sooner I can be productive.
Since you are updating exsisting diagreams, the first thing I'd do is
find out what diagrams they use and not worry about the others. There
are 13 defined diagrams, but I've yet to find anyone who knows and
uses all 13. Chances are, there are Use Case diagrams (very easy to
pick up), and probably something on a flow diagram.
I knows therw are some who look down on this series of books, but I'd
invest in the "UML for Dummies" book. After all, you don't need to
know everything about UML, just enough to maintain information. Pay
attention to the notation aspects of the diagrams. These are the
markups and weird little doodads that are added to the lines
connecting each box of the flow charts.
Since they are aware that you are going to be learning this as you go
along, ask MANY questions.
John Posada
Senior Technical Writer
"They say everyone needs goals. Mine is to live forever.
So far, so good."
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-