checkpoint

tat_requirements/introduction.md

 TAT Functional Requirements
 
-Authors
-=======
+#### Authors
+
 
 Tom Laudeman, Technical lead, University of Virginia, Institute for
 Advanced Technology in the Humanities
@@ -16,34 +16,16 @@ Ray R. Larson, U.C. Berkeley - School of Information
 
 Robbie Hott
 
-(other authors add yourselves here)
-
-### Discussion items:
+#### Organization of documenatation
 
-The order of files is:
+[Plan](plan.md) (external, broad view roadmap)
 
-plan (external, broad view roadmap)
+[Introduction (this document) ](introduction.md)
 
-introduction
+[Requirements](requirements.md)
 
 co-op background
 
-requirements
-
-What are .c and .r files in the merged data?
-
-If an .c file is creatorOf (presumably a resourceRelation) where is that
-preserved in the merged data? Check this out vis-a-vis the cpf SQL db.
-
-Edit UI data field validation API
-
-Most data entry needs validation, so we should plan for a validation
-layer that interacts with the UI and with the database. The ideal
-architecture is rule based validation as opposed to some hard coded ad
-hoc system. It would be even better if the rules were saved to the
-database and had a UI of their own, allowing non-programmers to update
-data validation rules (and the concomitant messages show to users when
-there is a validation error).
 
 #### Edit architecture requirements
 

tat_requirements/plan.md

@@ -29,6 +29,19 @@
 
 #### Code we write
 
+- Data validation API
+
+  - rule based system abstracted out of the code
+  - rules are data
+  - change the rules, not the actual application code 
+  - rules for broad classes of data type, or granular rules for individual fields
+  - probably used this to untaint data as well (remove things that are potential security problems)
+  - send all data through this API
+  - every rule includes a message describing what when wrong and suggesting fixes
+  - rules potentially editable by non-programmers
+  - rules are based on co-op data policies, which implies a data policy document, or the rules **can** be the
+    policy documentation.
+
 - Identitiy Reconciliation (aka IR) (architect Robbie)
 
  - needs docs wrangled