Skip to content

Original Software Requirements Doc

Timothy Duffy edited this page Mar 19, 2015 · 1 revision

#WXXI yellr Software Requirements Document# Timothy Duffy Hacks/Hackers Rochester May 23rd, 2014

##Background##

WXXI has been awarded a Knight INNovation Fund Grant to produce a mobile app and website to allow for citizens to post digital content, where it can then be curated and used by WXXI and its partners to tell the stories of those citizens.

The system will include a mobile app as well as a website with a number of different user permission levels based on use-case and affiliation. The website will include the ability to organize incoming content in a manner that is easy for others to absorb and use. It will also include the ability to broadcast questions to the user base to get opinions and insight to specific topics.

The entirety of the project’s software will be Open Source, licensed under an OSI approved license.

##Requirement Level Key Words##

####SHALL#### This word means that the definition is an absolute requirement of the specification.

####SHALL NOT#### This phrase means that the definition is an absolute prohibition of the specification.

##Stakeholders##

####USERS#### Individuals generating content

####ADMINISTRATORS#### System maintainers

####MODERATOR#### Individuals curating and moderating content

####SUBSCRIBERS#### Individuals using USER generated content and MODERATOR curated content

##Business Level Requirements##

####Definition Defines the business problems or opportunities about the product. Business requirements define why the software product is being developed. They are the objectives of the customer requesting the development of the software.

####BLR-0001#### To develop and roll out a mobile app and supporting web page to encourage and streamline aggregation of user-generated content. The goal is to broaden audience engagement, primarily with younger, mobile and under-represented community members.

“To empower individuals to become citizen journalists, where they are able to succinctly and quickly communicate their thoughts and concerns about topics within their communities through a digital aggregation platform.”

##User Level Requirements##

####Definition Describe what users (and others) SHALL get from the system in order to achieve the business needs. These are primarily about what the stakeholders will be able to achieve. This is again about the problem to be solved, but at a more detailed level.

####ULR-0001 There SHALL be a way for USERS to post images, video, text, and/or voice recordings so that MODERATORS and SUBSCRIBERS can access it.

####ULR-0002 There SHALL be a means for USERS to post media from a smartphone application.

####ULR-0010 All content SHALL have geolocation information associated with it.

####ULR-0020 There SHALL be a way for MODERATORS to publish questions, comments, and/or responses directly to USERS based on media posts.

####ULR-0030 There SHALL be a way for USERS to publish content anonymously or with their identity attached to it.

####ULR-0031 There SHALL be a unique identifier associated with each USER (such as a device UID).

####ULR-0032 USERS SHALL be able to post from multiple mobile platforms, including the website.

####ULR-0033 Mobile platforms SHALL include the support for multiple languages.

####ULR-0040 There SHALL be a way for USERS to sign up as a verified contributor which will match their unique ID to their identity and content.

####ULR-0050 It SHALL be extremely simple for a USER to post content to the server.

####ULR-0060 There SHALL be a way for ADMINISTRATORS to manage USERS’, MODERATORS’, and SUBSCRIBERS’ credentials (such as login(s), privileges, and access).

####ULR-0070 There SHALL be a way for ADMINISTRATORS to manage server functionality, monitor performance, and access/manipulate stored user content.

####ULR-0080 There SHALL be a way for MODERATORS to simply sort and organize USER content.

####ULR-0081 There SHALL be a way for MODERATORS to save curated content for display/use by SUBSCRIBERS.

####ULR-0082 There SHALL be a means for MODERATORS to display/present curated content to the public via a forward facing webpage.

####ULR-0090 There SHALL be a way for MODERATORS to tag/flag inappropriate content and repeat offending USERS.

####ULR-0100 There SHALL be a way for SUBSCRIBERS to simply sort and organize USER content and/or MODERATOR curated content.

####ULR-0110 There SHALL be a way for MODERATORS and/or SUBSCRIBERS to simply use USER and MODERATOR curated content on other sites (such as a Drupal-based news CMS).

##Product Level Requirements

####Definition Define what the system SHALL do in order to satisfy the stakeholder requirements. This includes the entire external, database, functional/non-functional requirements. [1],[2]

Note: All Product Level Requirements (PLR) will be defined using the github issues tracking system.

Clone this wiki locally