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.
Do the programmers/designers create FSPs? Have you reviewed the FSPs
(Feature Specifications)? The Company that I work for uses RUP (Rational
Unified Process) and each enhancement (ex. Prod 222) has a Feature Spec, Use
Case(s), and Supplementary Specifications. From my experience, reviewing the
Feature Spec and the accompanying Supplementary Specs gave me the needed
information for documentation. The Use Cases just told me what should
happen, but not what buttons to click. They aren't very helpful, but on rare
occasions, I have found little bits of information that I missed in FSPs &
Feature Specs (FSPs)
FSPs lay down the law for what should be included in the enhancement. For
example, if the software contains a new screen, the Feature Spec should tell
you what EVERY field and button means on that page. It should also say how
to populate each field, or what happens to it when you make changes. There
should also be a screen shot of what the actual screen should look like when
it's completed. The screen shot is usually a representation created with a
graphics program or in Word, but it does let you see where the
buttons/fields will be located.
Supplementary Specs (SSs)
They usually highlight what a secondary pop-up window within the screen or
another part of the software would look like as a result of the new
enhancement. These include the meaning of the new additions to the screen,
pop-up, etc... and also includes screen shots.
If they're only giving you Use Cases and claim to be following the laws of
RUP, they'd better get to work on some specs.
Hope that helps a little bit. :-)
Technical Writer (Software)
writinglady -at- hotmail -dot- com
----- Original Message -----
From: "Kelly Williamson" <kwcwtech -at- iwaynet -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Sent: Monday, October 22, 2001 5:34 PM
Subject: Use Cases
: Can anyone provide me with an example of a use case that has actually
: (read: was useful) in Real Life? We have some use cases that were
: for us, and I, as well as the programmer, am just not finding them useful
: whatsoever. The programmer is saying that there is info. in there that
: shouldn't be (such as "the user clicks the "Submit" button to submit the
: information"--he's saying that's going into the screen design. The use
: are also spelling out exactly what the error messages should say and he
: doesn't like that either.)
: The person doing the use cases is saying she's "going right by the book".
: have no formal training in RUP, unfortunately, and the use cases I've seen
: seem like a big waste of time--I'm just not seeing the value in them. So I
: thought if I could see a useful one, I might be able to get a better idea
: what a good one looks like. Alternatively, I could send one of ours to
: someone experienced in this area and see what you think.
: Any help on this topic is appreciated. We really have to make this project
: work, and this is a sticking point thus far.
: kwcwtech -at- iwaynet -dot- net
Announcing new options for IPCC 01, October 24-27 in Santa Fe,
New Mexico: attend the entire event or select a single day.
For details and online registration, visit http://ieeepcs.org/2001
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.