Home » Eclipse Projects » Eclipse Website » Functional Requirements Survey
| Functional Requirements Survey [message #562566] |
Fri, 06 May 2005 20:32 |
 Andrew Geraghty
Messages: 30
Registered: July 2009 |
Member |
|
|
The following is an initial draft list of high level actions intended to
help us identify, clarify, and organize the scope or functional
requirements the proposed system. (In this case the a new Eclipse.org
web site and administration interface) 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 function describe in two or three sentences what is involved
and move on.
Your participation is encouraged
Functional Requirements Survey
Action number - 001
Action name: Retrieve project downloads including: full release packages,
plug-in tools, development environments and software updates.
Initiating Actor(s): User, Committer, Contributor, Plug In Developer
Brief description: Initiating actor activates a link or button that
imitates the retrieval of a download. (Downloads can include full release
packages, plug-in tools and/or environments, updates to existing
installations or test patches.) Types of files may include .zip, .xml,.
exe. .rar) The Initiating Actor activates the download link to install or
review the file contents.
Project priority: High
Dependencies: the appropriate files have been posted to the website
Other comments: an alternative path in this action is the update manager
tool
Action number 002
Action 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.
Project priority: High
Dependencies: the search application has indexed the site content to
filter the results appropriately (limiting the search by criteria such as
date, range, type of documents and/or directory)
Other comments: at this time the recommendation is to have google be used
for the site wide search
Action number - 003
Action 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.
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
Action number - 004
Action 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.
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.
Action number 005 - A
Action 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
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: This action could include the categorizing and sorting of
content
Action number 005 - B
Action 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
Project priority: High
Dependencies: The CMS has a preview page option for previewing content.
Other comments:
Action number 005 - C
Action 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.)
Project priority: High
Dependencies: The developer defines separate environments for content
publishing and/or approvals. Workflow is in place for approvals
Other comments:
Action number - 006
Action 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.
Project priority: High
Dependencies:
Other comments:
Action number - 007
Action name: Process email form submissions
Initiating Actor(s): User, Committer, Contributor, Plug In Developer,
Member
Brief description: Initiating actor activates a 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.
Project priority: High
Dependencies: Workflow is in place to direct the form data to the
appropriate contact.
Other comments:
Action number 007 A
Action name: Collect Form Data
Initiating Actor(s): User, Committer, Contributor, Plug In Developer,
Member
Brief description: Initiating actor activates a link to submit data via a
form. User is presented with a form and fills out required fields (e.g.
subject, date, etc
) and activates submit button.
Indication of the complexity: low
Dependencies: Workflow is in place to direct the data to the appropriate
repository. Data is validated (depending on the requirement) and accepted
into the system
Other comments:
Action number - 008
Action 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:
Action number - 009
Action 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
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
Action number - 010
Action 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
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:
Action number - 011
Action 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
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 action 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)
Action number - 012
Action 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
Project priority: High
Dependencies: The developer provides an interface for registering BLOGS.
Other comments:
Action number - 013
Action 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. The site ranking
application updates the page content to reflect the updated ranking.
Project priority: Medium
Dependencies: There is a ranking application that can publish site
rankings to the web site.
Other comments:
Action number - 014
Action 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:
Action number - 015
Action 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
Project priority: High
Dependencies: The initiating actor has a RSS reader or aggregator
Other comments:
Action number - 015
Action 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
Project priority: High
Dependencies: The initiating actor has a RSS reader or aggregator
Other comments:
Action number - 016
Action name: Automatically configure Eclipse software with CVS repository
Initiating Actor(s): Committer
Brief description: A committer activates a link on the website for
configuring an instance of Eclipse with a particular projects common
CVS repository. This connection lets a code developer save and retrieve
different development versions of source code to the CVS repository via
the web site. It also lets a team of developers share control of different
versions of files in a common repository of files.
Project priority: High
Dependencies: the developer has implemented a script and/or agent that
enables the automatic configuration of common project CVS repositories
with eclipse software
Other comments: Other Actors in this action include the Concurrent Version
Software (CVS) and the Eclipse software instance. Currently the ability to
configure CVS repositories with Eclipse software instances is not
available; rather there is static content with instructions on how to do
this action manually.
|
|
|
Goto Forum:
Current Time: Sat Apr 20 03:43:29 GMT 2024
Powered by FUDForum. Page generated in 0.03210 seconds |
] 
Search
Help
Register
Login
Home
