Versions Compared

Version Old Version 70 New Version 71
Changes made by

Nora Roggeveen-Sams (Unlicensed)

Nora Roggeveen-Sams (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Section
Column
width50%
{toc:outline=false|minLevel=1}
Panel
borderStyle
borderColor#A40000
bgColor#F8F8F8
titleBGColor#E8E8E8
borderStyledashed
titleContents
Wiki Markup
Table of Contents
dashed
minLevel1
outlinefalse
Column

In the revised OLE Development process, we are distinguishing between:

  • User Requirements - preliminary functional specifications or requirements documented by the Spec Teams for User Stories (see Specification & Documentation Templates for samples and templates)
  • Codeable (Complete & Final) Specifications - taking the above draft user requirements, and translating into FINAL codeable specs for developers
Section
h2.

Completing

Codeable

Specifications

#

  1. Review
  1. Draft
  1. User
  1. Requirements
#
  2. Use
  1. Spec
  1. Team
  1. Draft
  1. User
  1. Requirements
  1. to
  1. start
  1. and
  1. extend
  1. final
  1. specs,
  1. or,
##
    1. Combine
    1. multiple
    1. Spec
    1. Team
    1. drafts
    1. into
    1. final
    1. use
    1. case/specification
    1. document
    1. (if
    1. determined
    1. with
    1. BA),
    1. or,
##
    2. Extract
    1. portions
    1. of
    1. Spec
    1. team
    1. draft
    1. into
    1. technical
    1. or
    1. foundational
    1. spec
    1. document
    1. (to
    1. enable
    1. coding
    1. of
    1. dependencies
    1. in
    1. advance.
    1. Ex.
    1. Circulation
    1. Policy,
    1. Instance
    1. Record)
#
  2. Admin:
  1. SA
  1. must
  1. annotate
  1. and
  1. track
  1. how
  1. final
  1. specs
  1. are
  1. being
  1. combined
  1. in
  1. #2
  1. above
  1. and
  1. reflect
  1. those
  1. changes
  1. 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}
  1. (exact
  1. admin
  1. process
  1. being
  1. determined
  1. for
  1. turning
  1. over
  1. specs
  1. to
  1. Project
  1. Management
  1. and
  1. Spec
  1. inventory)
#
  2. Work
  1. with
  1. Project
  1. Team,
  1. Developers
  1. and
  1. Technical
  1. Architect
  1. to
  1. inform
  1. follow-on
  1. or
  1. confirming
  1. Technical
  1. Specifications,
  1. or
  1. how
  1. we
  1. will
  1. "interpret
  1. functional
  1. requirements
  1. in
  1. KFS-Rice
  1. 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:

#

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

Column
width50%
Wiki Markup
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}[
Column
Wiki Markup

Templates

]{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}[]{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}[

    • 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 Red (except new appendices)
      • Section 11 (UI) is greatly extended
      • New Sections: 12, 13 (Maintenance Docs, Search)
      • New Appendices 2,3,4

  • HTML Comment

    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}[]{HTMLcomment} * See Business

  • See Business Rules,
  • Workflows,
  • Roles
  • &
  • Reference
  • Documentation:
[ 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}[]{HTMLcomment}

Extensions to Final or Codeable Specifications

...