Page Comparison

h2. Completing Codeable Specifications

# Review Draft User Requirements
# Use Spec Team Draft User Requirements to start and extend final specs, or,
## Combine multiple Spec Team drafts into final use case/specification document (if determined with BA), or,
## Extract portions of Spec team draft into technical or foundational spec document (to enable coding of dependencies in advance. Ex. Circulation Policy, Instance Record)
# Admin: SA must annotate and track how final specs are being combined in #2 above and reflect those changes in {link-window:https://jira.kuali.org/browse/OLE|scrollbars=true|menubar=true|location=true|statusbar=true|resizable=true|width=800|height=600|icon=false}OLE Jira{link-window} (exact admin process being determined for turning over specs to Project Management and Spec inventory)
# Work with Project Team, Developers and Technical Architect to inform follow-on or confirming Technical Specifications, or how we will "interpret functional requirements in KFS-Rice coding"

h2. Codeable Specs - Step-by-Step

Final or Codeable specification will need to extend the draft User Requirements, by filling in any gaps or additional details, and then augmenting those specs with Non-Functional Requirements (where applicable). In total, may include:

# Complete existing User Requirements Sections and extend for
## Complete Acceptance Criteria
## Add/edit existing AC for functional requirements
## Add AC for non-functional requirements
## Extend User Requirements for KFS/inherited functions and UI translations
## Workflow/Routing Requirements (as needed)
## Reconciliation & Additions to Roles/Permissions Matrix
## Error Handling and Messaging Requirements
## Annotate Complex Business Rules Requirements (KRMS)
# Add new functional sections:
## UI Wireframes
### including UI inventory
### Intra-spec, Intra-process UI and Navigation needs
## Maintenance Document Needs (with Data Architect)
### including workflows and permissions for each
## Federated Search extensions (iterative workshops & documentation to extend Search/Docstore)
# Add Appendices for non-functional requirements
## Document Revision History
## Index/links to Reference Documentation
## Dependencies (added to spec)
## Document & System Control Requirements
### Audit Trail Requirements
### Version Control Requirements (Docstore)
### Document Statuses
## Interoperability Requirements: API specification (from SA or TC member of SME Team) for system integration points
## Scalability/Load/Performance Requirements
## Privacy Requirements (if applicable, and as extension of Permissions)
## Design & Implementation Notes (Assumptions, Constraints, Issues)
## Sample Data & Mappings for Testing (with spec team, TC)

h2. Templates

* {link-window:http://goo.gl/lZBc0|scrollbars=true|menubar=true|location=true|statusbar=true|resizable=true|width=800|height=600|icon=false}{*}Final Specifications Template{*}{link-window}
{HTMLcomment}[https://docs.google.com/a/kuali.org/document/d/1mgymZ80ckxS02HdZjjLBU8GZv49Oum8t3egx0ftCs3M/edit?hl=en_US]{HTMLcomment}
** Sample:{link-window:http://goo.gl/kzwDY|scrollbars=true|menubar=true|location=true|statusbar=true|resizable=true|width=800|height=600|icon=false}Create Chart of Accounts Part 1{link-window}
{color:#ff0000}More to come...{color}
{HTMLcomment}[https://docs.google.com/a/kuali.org/file/d/0B4D2uLuq2OS7T3RpeDhmY0FSS2V4bnNKUmZDTEVqZw/edit]{HTMLcomment}
** FINAL template includes ALL requirements sections
*** KFS existing functions can be translated in integrated spec format
*** SA's and Project Team can remove any sections not relevant to the spec in progress
** Notes on format:
*** Template for "final" is in same order/sections as "user requirements"
New notes/extensions throughout are in {color:#ff0000}Red{color} (except new appendices)
*** Section 11 (UI) is greatly extended
*** New Sections: 12, 13 (Maintenance Docs, Search)
*** New Appendices 2,3,4
* {link-window:http://goo.gl/GEQcd|scrollbars=true|menubar=true|location=true|statusbar=true|resizable=true|width=800|height=600|icon=false}{*}Blank Roles and Routing Template{*}{link-window}
{HTMLcomment}[https://docs.google.com/a/kuali.org/spreadsheet/ccc?key=0AlzG4eNDtxYpdDBaTmRjWGVsUnAzQU5kZ1pkUmVmUVE&hl=en_US#gid=0]{HTMLcomment}
* {link-window:http://goo.gl/hM9Gi|scrollbars=true|menubar=true|location=true|statusbar=true|resizable=true|width=800|height=600|icon=false}{*}KRMS Rules Template{*}{link-window} (link to template location - early draft in progress)
{HTMLcomment}[https://docs.google.com/a/kuali.org/document/d/10fgvhWMUOCLr2kvffy9RwIPnBs0vI-5sKcR70YjuTEw/edit?hl=en_US]{HTMLcomment}
* See Business Rules, Workflows, Roles & Reference Documentation: [SME Team SA - Spec Writing & Analysis: Reference|SME Team SA - Spec Writing & Analysis#ref]
* Review or complete {link-window:http://goo.gl/MGV3d|scrollbars=true|menubar=true|location=true|statusbar=true|resizable=true|width=800|height=600|icon=false}{*}Data Requirements Worksheet{*}{link-window}
{HTMLcomment}[https://docs.google.com/a/kuali.org/spreadsheet/ccc?key=0AlzG4eNDtxYpdFVZekVWUzdhT0U5M0JrcEwxNllTZUE&hl=en_US#gid=1]{HTMLcomment}