Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
Documentation
Project
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
Rachael Hu
Documentation
Commits
cd060a77
Commit
cd060a77
authored
Jul 16, 2015
by
Tom Laudeman
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
working on requirements list
parent
a669cc28
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
50 additions
and
11 deletions
+50
-11
requirements.md
tat_requirements/requirements.md
+50
-11
No files found.
tat_requirements/requirements.md
View file @
cd060a77
List of requirements
List of requirements
---
---
This is the definitive list of all requirements. Anything the application needs to do must be in this
list. Each item and group of items is explained in detail later in the document. Being a "list", this includes
only sufficient detail to disambiguate items.
-
authentication
-
authentication
-
user creation
-
user creation
...
@@ -9,7 +13,7 @@ List of requirements
...
@@ -9,7 +13,7 @@ List of requirements
-
authorization
-
authorization
-
user/group/other (ugo) with read/write (rw) privil
i
ge system, typical for Linux
-
user/group/other (ugo) with read/write (rw) privil
e
ge system, typical for Linux
-
admin tool for group privs
-
admin tool for group privs
-
create/edit/delete groups
-
create/edit/delete groups
-
create privs matched to API functionality
-
create privs matched to API functionality
...
@@ -18,19 +22,30 @@ List of requirements
...
@@ -18,19 +22,30 @@ List of requirements
-
dashboard
-
dashboard
-
dashboard
-
search history
-
clear history
-
search history
-
work status
-
change sort order (maybe version 2)
-
system/work flow messages
-
account settings
-
social media features
-
edit cpf data
-
edit cpf data
-
edit UI
-
edit UI
-
per field data validation
-
per field data validation
-
record validation
-
record validation
-
user message system in UI
-
user message system in UI
-
workflow
-
work
flow
-
dashboard for workspace, task list
-
dashboard for workspace, task list
-
split merged records, know that some record consists of merged records
-
split merged records, know that some record consists of merged records
-
split UI
-
split UI
-
workflow
-
work
flow
-
ARK assign, deprecate (generally: manage ARKs)
-
ARK assign, deprecate (generally: manage ARKs)
-
dashboard
-
dashboard
...
@@ -38,7 +53,7 @@ List of requirements
...
@@ -38,7 +53,7 @@ List of requirements
-
Identity Reconciliation (IR)
-
Identity Reconciliation (IR)
-
search/view merge candidates
-
search/view merge candidates
-
workflow
-
work
flow
-
dashboard
-
dashboard
-
manage ARKs
-
manage ARKs
...
@@ -54,20 +69,20 @@ List of requirements
...
@@ -54,20 +69,20 @@ List of requirements
-
Linux, Apache httpd, PostgreSQL (aka Postgres)
-
Linux, Apache httpd, PostgreSQL (aka Postgres)
-
HTML, CSS, JavaScript
-
HTML, CSS, JavaScript
-
workflow
-
work
flow
-
workflows
-
work
flows
-
may want wild-west non-locking edits
-
may want wild-west non-locking edits
-
may want locked, moderated workflow
-
may want locked, moderated work
flow
-
ability to issue reminders
-
ability to issue reminders
-
integrated email notification
-
integrated email notification
-
"watched" records (might be reporting, and not specifically workflow)
-
"watched" records (might be reporting, and not specifically work
flow)
-
-
-
reporting
-
reporting
-
helpdesk
-
help
desk
-
issue tracking
-
issue tracking
...
@@ -76,6 +91,30 @@ List of requirements
...
@@ -76,6 +91,30 @@ List of requirements
-
data integrity testing
-
data integrity testing
List of Application Programmer Interfaces (APIs)
----
The following include both direct programming language intefaces, and REST interfaces. We need to determine
which (REST/direct) is available for each. Modifying data should probably go through authorization and should
probably be subject to work flow, and that implies that the work flow has a REST interface, and this is the
only public interface.
-
Identity Reconciliation (IR) (direct)
-
work flow manager (REST)
-
name string parser (direct)
-
date parser (direct)
-
data validation (direct)
-
web UI messages (direct)
-
work flow messages (REST?)
-
record watching (REST?)
Maintenance Functionality (All authors)
Maintenance Functionality (All authors)
---------------------------------------
---------------------------------------
...
@@ -97,14 +136,14 @@ institution-affiliated experts with a vested interest in the data. In
...
@@ -97,14 +136,14 @@ institution-affiliated experts with a vested interest in the data. In
the future, the maintenance function may be opened to highly qualified
the future, the maintenance function may be opened to highly qualified
(perhaps amateur) content experts. The software must therefore support
(perhaps amateur) content experts. The software must therefore support
policies such as vetting and moderation so that we avoid the pitfalls of
policies such as vetting and moderation so that we avoid the pitfalls of
unregulated crowdsourcing.
unregulated crowd
sourcing.
The system will require changes to be reviewed by a moderator before
The system will require changes to be reviewed by a moderator before
becoming part of the production system. Administrative policy may
becoming part of the production system. Administrative policy may
streamline these requirement, but the software functionality needs to
streamline these requirement, but the software functionality needs to
exist at the most granular level for which we can imagine reasonable
exist at the most granular level for which we can imagine reasonable
business logic. For the sake of security and general peace of mind,
business logic. For the sake of security and general peace of mind,
every change to the system must be captured (a
l
a versioning) in an audit
every change to the system must be captured (a
k
a versioning) in an audit
trail, and there are no destructive changes. For example, there is no
trail, and there are no destructive changes. For example, there is no
“delete” per se, because the delete feature only hides descriptions from
“delete” per se, because the delete feature only hides descriptions from
public view. Updated descriptions will be subject to version control so
public view. Updated descriptions will be subject to version control so
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment