OLE Document Controls

Owned by Kathleen Gerdink (Unlicensed)
Last updated: Aug 28, 2012 by Nora Roggeveen-Sams (Unlicensed)Version comment
3 min read

(question)  (draft Sept 2011).  To be updated to reflect new OLE Development Cycle. 

Documentation Change Control

(coming soon)

Working docs and tools:
  • Release Docs: OLE November Pre-Release Narrative Draft and November Release (Jira) Priority 28, with the SME Team Roadmap Document to convey descriptions of Releases as determined by Roadmap SME Team, Project Management. Could foresee continuing this with sprint/release specific planning docs to communicate clearly to FC, TC, new spec teams or SMEs for onboarding (Roadmap spreadsheet plus release-specific narrative description). Could also be used by Patty & Beth for communications where they see fit/excerpt content. Audience: FC, TC, onboarding SMEs.{
  • Unknown macro: {html}

    <A href="https://jira.kuali.org/browse/OLE" mce_href="https://jira.kuali.org/browse/OLE" target="_Blank"><STRONG>OLE Jira</STRONG></A>

    : Still the defacto coding and user stories portal, to which we add functional documentation for User Stories. Rich has added a new Fix/Version for “March” and we will begin to add jira tasks or portions of stories as outlined last week that have “fallen out of November” prerelease. We also continue to add new tasks, sub-tasks and spec clarifications for coding here, as a result of our updates from the working spec teams. The additional comments, corrected or added documentation are where we would add clarifications to data model, doc relationships, functional spec overviews or interactions (like action items on how we implement serials for November or Bib-item relationship for November coding). Audience: used by Project Team; available to all.
  • Unknown macro: {html}

    <A href="https://docs.google.com/a/kuali.org/?ui=1#folders/folder.0.0B4DWNTr-9s9XZDBkOGNmZDUtZjJkOS00NDNjLTg0MjUtMjllNzhlZmI5YWVi" mce_href="https://docs.google.com/a/kuali.org/?ui=1#folders/folder.0.0B4DWNTr-9s9XZDBkOGNmZDUtZjJkOS00NDNjLTg0MjUtMjllNzhlZmI5YWVi" target="_Blank"><STRONG>OLE Docs</STRONG></A>

    : still houses all in-progress or reference documentation that we are still working on or spec teams are drafting in the individual library process folders. Includes Core Team folder and Developer Documents folder for communicating documentation preliminarily between Project Team entities for reference. Will need to cleanup how we use these files and what needs to go to HTC or be attached to Jira issues. Shared action items, meeting notes, work in progress would live here until finalized and attached to Jira. Audience: Project Team.
  • Team Organization: See related reference summary documents for SME resources. SME Teams need to be finalized, with full onboarding and introduction to task assignments. Still need some members confirmed, and need to engage HTC in process discussions where needed. The Spec Roadmap details all the current and previous SMEs utilized in specification and requirements-gathering efforts, with some description of activities or status.

Wiki + Jira with Links to Google Docs: Project internal & external Communications

  • To be further developed with Carla as administrator to marry Google docs links to critical organization and communications in Wiki: project updates, project communications, links to team materials, organizing meeting agendas & minutes, etc. TBD with direction from P Mescher.

Release Communications and Scheduling

  • To be determined with P Mescher. To differentiate working code/spec reviews from Milestone demos and releases (different audiences; some require PPT or introduction; others require access to TEST). Who and how initiated or invited….
    Unknown macro: {html}

    <A HREF="https://docs.google.com/a/kuali.org/viewer?a=v&pid=explorer&chrome=true&srcid=0B1zG4eNDtxYpYTgxOTdiZjgtMTMzYS00YTI2LTg5YTMtZjNkNjI4OWFmMGVl&hl=en_US" mce_href="https://docs.google.com/a/kuali.org/viewer?a=v&pid=explorer&chrome=true&srcid=0B1zG4eNDtxYpYTgxOTdiZjgtMTMzYS00YTI2LTg5YTMtZjNkNjI4OWFmMGVl&hl=en_US" target="_Blank">Draft</A>

    .

Data Modeling

  • Reference working documents and archives in Google Docs for active spec teams, and see Jira, OLE-1190, with its sub-tasks (need to make sure all developers are “watchers”. KG to better document UI additions via new OLE data elements for functionality in future KFS adaptations and functional specs. HTC to also reference fSpecs and DM changes while coding

OLE Published Documentation

Change Controls: TBA

NEED TO CONFIRM AND IMPROVE CHANGE MANAGEMENT AND COMMUNICATION FOR CHANGES TO DOCUMENT VERSIONS- WHAT ARE DRAFTS, WHAT ARE CODING, CHANGES TO DOCUMENTS HTC ALREADY USING IN CODING.

Operated as a Community Resource by the Open Library Foundation