Commit 2e51e24c by Tom Laudeman

move sections, minor format changes

parent 6fca1af6
......@@ -25,8 +25,6 @@ Robbie Hott
[Requirements](requirements.md) (Tech requirements from Rachael's spreadsheets)
#### co-op background
#### Introduction to SNAC
Social Networks and Archival Context (SNAC) is a Mellon-funded project
......@@ -419,6 +417,7 @@ CPF records will be linked to relevant recources. Brian suggest actively harvest
to the sitemap protocol along the lines of ResourceSync. Brian notes that the updates are based on linked
data, not submission of XML files.
#### Current State Conclusion
......@@ -427,24 +426,5 @@ processed. These systems will benefit from additional work to make them more mat
software develops: robustness, testing and QA, documentation, examples, consistent API. Most of the current
software will be used in the production product.
#### Required and Planned Functionality (All authors)
(We need to break out each item into UI functionality, and API
functionality.)
#### Documentation
System documentation is in http://gitlab.iath.virginia.edu in markdown files.
Every aspect of the system requires documentation. Most visible to the public is the user interface for
discovery. Maintenance will be complicated, and our processes are somewhat novel, so this will need to be
extensive, well illustrated with screenshots, and carefully tested.
Documentation intended for developers might be somewhat sparse by comparison, but will be critical to the
on-going software development process. All the databases, operating system, httpd and other servers need
complete documentation of installation, configuration, deployment, starting, stopping, and emergency
procedures.
plan.md
--------
plan.md #### Big questions
plan.md Big questions
plan.md #### Overview and order of work
plan.md Overview and order of work
plan.md #### Code we write
plan.md Code we write
plan.md #### Controlled vocabularies and tag system
plan.md Controlled vocabularies and tag system
plan.md #### Code we use off the shelf
plan.md Code we use off the shelf
co-op_background.md
-----
co-op_background.md #### Authors
Authors
co-op_background.md #### Organization of documenatation
Organization of documenatation
co-op_background.md #### Introduction to SNAC
Introduction to SNAC
co-op_background.md #### Evaluation of Existing Technical Architecture
Evaluation of Existing Technical Architecture
co-op_background.md #### Overview
Overview
co-op_background.md #### Current State of the System
Current State of the System
co-op_background.md #### Processing Pipeline
Processing Pipeline
co-op_background.md #### Extraction
Extraction
co-op_background.md #### Match/Merge
Match/Merge
co-op_background.md #### Discovery/Dissemination
Discovery/Dissemination
co-op_background.md #### Prototype research tool
Prototype research tool
co-op_background.md #### Gap analysis
Gap analysis
co-op_background.md #### Data maintenance
Data maintenance
co-op_background.md #### Pilot phase architecture
Pilot phase architecture
Current State Conclusion
co-op_background.md #### Current State Conclusion
introduction.md
--------
introduction.md #### Software development, processes, and project management
TAT Functional Requirements
introduction.md #### QA and Related Tests for Test-driven Development
Introduction to Planned Functionality
introduction.md #### Documentation
Software development, processes, and project management
introduction.md #### Data background
QA and Related Tests for Test-driven Development
introduction.md #### What is "normal form" and what informs the database schema design?
Documentation
introduction.md #### Edit architecture requirements
Required new features
introduction.md #### Required and Planned Functionality
Data background
introduction.md #### Expanded CPF schema requirements
What is "normal form" and what informs the database schema design?
introduction.md #### Expanded Database Schema
Edit architecture requirements
introduction.md #### Introduction to Planned Functionality
Expanded CPF schema requirements
introduction.md #### Required new features
Expanded Database Schema
introduction.md #### Merge and watch
Merge and watch
introduction.md #### Brian’s API docs need to be merged in or otherwise referred to:
Brian’s API docs need to be merged in or otherwise referred to:
introduction.md #### Not sure where to fit these topics into the requirements. Some of them may not be part of technical requirements:
Not sure where to fit these topics into the requirements. Some of them may not be part of technical requirements:
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment