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:Re: Software Requirements Specification Question From:jsokohl -at- mac -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 6 Oct 2004 09:54:27 -0600
> Would this best be structured as a single use case with search by =
> keyword
> and search for article # being functional specifications for it?
>
> Or would it be best structured as 3 separate use cases, with Search =
> Articles
> containing Includes for "search by keyword" and "search for article #"?
>
> Or would it best be structured a 2 separate use cases: "search by =
> keyword"
> and "search for article #"?
>
Hi Noa,
Of course, it depends, :), but here's a couple of things to think about:
1. Essential use cases, as defined by Constantine & Lockwood (1999),
provides a better way to capture and reflect the way people interact with
a system, as opposed to how systems interact with other systems. See Scott
Ambler's http://www.agilemodeling.com/artifacts/essentialUseCase.htm for a
nice example & description.
Here's how I would write the use case (top of my head, no data, blah blah
blah disclaimer blah blah blah)--anyway, hope it helps:
Actor: Information Seeker
Preconditions:
1. Information searcher posesses a need to find information. is logged in
(if your system requires it).
2. Information searcher has a known item, either article number or a
keyword, to find.
Postconditions: None
Actions:
1. Information Seeker accesses the search interface.
2. Information Seeker enters a keyword or an article number into the
search interface.
2a.The search interface displays the characters as they are inputted.
3. Information Seeker invokes the search.
3a.The search engine compares the entered characters with the database
(cross-ref: Use case that defines the search engine)
3b. The search engine determines any matches and returns those matches to
the screen. [Alt 3b]
4. The Information Seeker accesses the returned items.
Alternate Actions
3b. The search engine determines any matches and finds no match. The
search engine then returns a message informing the Information Seeker.
ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!
TRY IT TODAY at http://www.macromedia.com/go/techwrl
WEBWORKS FINALDRAFT: New! Document review system for Word and FrameMaker
authors. Automatic browser-based drafts with unlimited reviewers. Full
online discussions -- no Web server needed! http://www.webworks.com/techwr-l
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.