| [phoenix-dev] Draft Use Case Survey - phoenix |
The following is an initial list of use cases [1] intended to outline the scope/functional requirements of the proposed system. The level of detail expressed here is crucial because too much detail could hurt the iterative nature of our requirements gathering process. What is important here is to identify the need for the use case describe in two or three sentences what is involved and move on.
Use
Case Survey (Draft thus far)
Use
case number
- 001
Use
case name: Downloads
available code samples, software developers kits, drivers, plug-ins tools and packaged
collections of project downloads
Initiating
Actor(s): User,
Committer, Contributor, Plug –In Developer
Brief
description: Initiating
actor activates a link or button to download available code samples, packaged
collections and project downloads. Types of files may include: **.exe. *.zip, .rar ) The Initiating
actor activates the download link to review the existing
attachment.
Indication
of the complexity: low
Architectural
priority: High
Project
priority: High
Dependencies: the
appropriate files have been posted to the website
Other
comments: It
is not clear what the difference between downloading a ‘file’ and downloading a
‘project’
Use
case number
– 002
Use
case name: Site
Wide-Search
Initiating
Actor(s): User,
Committer, Contributor, Plug –In Developer, Member
Brief
description: Initiating
actor enters a search query into a search field. A list of all matching
documents and attachments is returned to the actor. The actor can browse and
activate the linked items and review the appropriate document and/or attachment
in context.
Indication
of the complexity: medium
Architectural
priority: High
Project
priority: High
Dependencies: the
search application has indexed the site content to filter the results
appropriately
Other
comments: at
this time the recommendation is to have google be used for the site wide
search
Use
case number
- 003
Use
case name: Browse
Site Map
Initiating
Actor(s): User,
Committer, Contributor, Plug –In Developer, Member
Brief
description: Initiating
actor browses a category in a site index function. A list of all subcategories
and/or documents contained in that category is revealed to the initiating actor.
The actor can browse and/or review the appropriate subcategories and/or links
and activate the links view the content in context.
Indication
of the complexity: medium
Architectural
priority: High
Project
priority: High
Dependencies: The
developer defines a query to retrieve all files and folders. This query updates
the site map in runtime as content is published to the production
environment.
Other
comments: N/A
Use
case number
- 004
Use
case name: Scroll
News Portlets
Initiating
Actor(s): User,
Committer, Contributor, Plug –In Developer, Member
Brief
description: Initiating
actor browses and reviews a news portlet of a particular page on the web site.
(For example: the home page can display the “10” most recent headlines in a
community news list containing “40” headlines) The initiating actor can browse
this list of headline links without actually leaving the page. Once the actor
has viewed the appropriate headline link he can activate it and view it in
context.
Indication
of the complexity: High
Architectural
priority: High
Project
priority: High
Dependencies: The
developer defines a query to retrieve all headlines within the appropriate news
section and display them in a portlet.
Other
comments: This
function is needed to maximize on page real estate and provide access to
headlines in several places on the main and/or project
sites.
Use
case number
– 005 - A
Use
case name: Create new
web content
Initiating
Actor(s): Content
Creator
Brief
description: Initiating
actor creates content for the web site to be reviewed and approved in a
non-public (DEVELOPMENT) environment
Indication
of the complexity: High
Architectural
priority: High
Project
priority: High
Dependencies: The
developer defines separate environments for content creation.
Workflow is in
place for approvals. The DEVELOPMENT and STAGING environments are accessible to
Content Creators, Approval Managers and Users with read/Write Access. Granular
Security is in place to manage this R&W access. The developer also defines a browser
enabled CMS interface for web content creation
Other
comments:
Use
case number
– 005 - B
Use
case name: Preview newly
created content applicable environment
Initiating
Actor(s): Content
Creator
Brief
description: Initiating
actor chooses “preview page” option to view newly created content in
context
Indication
of the complexity: High
Architectural
priority: High
Project
priority: High
Dependencies:
The
CMS has a preview page option for previewing content.
Other
comments:
Use
case number
– 005 - C
Use
case name: Publish content for approval in
applicable environment
Initiating
Actor(s): Content
Creator
Brief
description: Initiating
actor publishes content to the [STAGING} environment for approval, or if content
has been approved to the [PRODUCTION] environment for public viewing. (Once the article has approved, the
initiating actor needs to publish the content to a second “test” environment
(User Acceptance Testing) for testing and and/or approval for publishing to a
“public” (PRODUCTION) environment for public consumption.)
Indication
of the complexity: High
Architectural
priority: High
Project
priority: High
Dependencies: The
developer defines separate environments for content publishing and/or approvals.
Workflow is in place for approvals
Other
comments:
Use
case number
- 006
Use
case name: Subscribe
for specific newsletters
Initiating
Actor(s): User,
Committer, Contributor, Plug –In Developer, Member
Brief
description: Initiating
actor activates a link to a “role specific” newsletter. The initiating
actor selects a checkbox for “HTML” or “TEXT” enters their email and activates a
link or button to subscribe to the newsletter.
Indication
of the complexity: medium
Architectural
priority: High
Project
priority: High
Dependencies:
Other
comments:
Use
case number
- 007
Use
case name: Process
email form submissions
Initiating
Actor(s): User,
Committer, Contributor, Plug –In Developer, Member
Brief
description: Initiating
actor activates an email link to write an inquiry about the web site and/or its
content. An email form pops up with required fields (e.g. subject, date, etc…)
to direct the email to the appropriate contact.
Indication
of the complexity: low
Architectural
priority: High
Project
priority: High
Dependencies: Workflow
is in place to direct the email to the appropriate
contact.
Other
comments: N/A
Use
case number
- 008
Use
case name: Track
changes via RSS Feeds
Initiating
Actor(s): User,
Committer, Contributor, Plug –In Developer
Brief
description: Initiating
actor retrieves an RSS feed that provides change tracking information. (E.g.
release changes, architectural changes, API changes) The initiating actor can
activate a link in the RSS feed and review the content in context.
Indication
of the complexity: medium
Architectural
priority: High
Project
priority: High
Dependencies: The
developer creates an RSS feed that indicates new information (via an icon, date,
etc.)
Other
comments: N/A
Use
case number
- 009
Use
case name: Post
information via collaborative tools
Initiating
Actor(s): User,
Committer, Contributor, Plug –In Developer
Brief
description: Initiating
actor post discussion information to a collaborative tool (E.g. a newsgroup
discussion) via the web site
Indication
of the complexity: Medium
Architectural
priority: High
Project
priority: High
Dependencies: The
developer provides a link to the newsgroup that the actor can activate in order
to create the posting.
Other
comments: suggested
collaborative tools at this time include: fourms, newsgroups, BLOGS, Wikis
and mail list
Use
case number
- 010
Use
case name: Access
developer tools
Initiating
Actor(s): User,
Committer, Contributor, Plug –In Developer
Brief
description: Initiating
actor activates a site link that provides access to CVS and/or
Bugzilla
Indication
of the complexity: Medium
Architectural
priority: High
Project
priority: High
Dependencies: The
developer provides a link to the appropriate tool(s) the actor needs access to.
The initiating actor should have appropriate access to the
tool
Other
comments:
Use
case number
- 011
Use
case name: Access
3rd party tools, support and/or plug-ins
Initiating
Actor(s): User
Brief
description: Initiating
actor browses the web site for a link (in context) to a third party
tool
Indication
of the complexity: Low
Architectural
priority: High
Project
priority: High
Dependencies: The
developer provides a link to the appropriate third party web site the actor
needs access to. The third part web site provides a link to the file
download.
Other
comments: In
order for this use case to be successful, the Eclipse web site must provide
content that places this link in context (i.e. a brief description of the tool,
which manages and provides it)
Use
case number
- 012
Use
case name: Registering
BLOGS through an administrator interface
Initiating
Actor(s): User,
Committer, Contributor, Plug –In Developer
Brief
description: Initiating
actor creates a BLOG and wishes to register it on the Eclipse.org web
site
Indication
of the complexity: Medium
Architectural
priority: Medium
Project
priority: High
Dependencies: The
developer provides an interface for registering
BLOGS.
Other
comments:
Use
case number
- 013
Use
case name: Rank
Site Content and/or Pug-ins
Initiating
Actor(s): User,
Committer, Contributor, Plug –In Developer
Brief
description: Initiating
actor reviews web site content (i.e. plug-in, article, books, project, etc…) on
reviewing the content the initiating actor activates a provided link to collect
user ratings filling in appropriate fields and selecting desired rating.
Indication
of the complexity: Medium
Architectural
priority: Medium
Project
priority: Medium
Dependencies: The
developer provides a link to the appropriate third party web site the actor
needs access to. The third part web site provides a link to the file
download.
Other
comments:
Use
case number
- 014
Use
case name: Search
the newsgroup archive
Initiating
Actor(s): User,
Committer, Contributor, Plug –In Developer, member
Brief
description: The
initiating actor activates a newsgroup search to narrow search results on a
particular subject. The initiating actor enters a search query (single terms or
phrases) and activates a link that results in a list of newsgroups discussion
sorted by relevancy and/or date.
Indication
of the complexity: High
Architectural
priority: Medium
Project
priority: High
Dependencies: The
search application has indexed the newsgroup discussions
appropriately
Other
comments:
Use
case number
- 015
Use
case name: Subscribe
to specific RSS (Really Simple Syndication) feeds
Initiating
Actor(s): User,
Committer, Contributor, Plug –In Developer, member
Brief
description: Initiating
Actor activates a link and/or button to have a “user specific” RSS feed
delivered in and RSS reader or aggregator
Indication
of the complexity: Medium
Architectural
priority: Medium
Project
priority: High
Dependencies: The
initiating actor has a RSS reader or aggregator
Other
comments:
[1] Use cases
are to identify, clarify, and organize system requirements (In this case
the web site and administration interface). The use case is made up of a set of
possible sequences of interactions between the web site, administrators and
users The use case should contain all system activities that have
significance to the administrators and users. A use case can be thought of as a
collection of possible
scenarios related to a particular goal or function.
A use
case (or set of use cases) has these characteristics:
Attachment:
Draft Case Survey v1.0.pdf
Description: Adobe PDF document