Uploaded image for project: 'Kuali Rice Roadmap'
  1. Kuali Rice Roadmap
  2. KRRM-50

A consistent documentation framework for all Rice components (see KRICE Documentation)

    Details

    • Type: Rice Enhancement
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Component/s: KEN, KEW, KIM
    • Labels:
      None
    • Rice Theme:
      Development Ease of Use
    • Priority Score:
      10
    • Priority - KFS:
      Medium
    • Priority - KC:
      Medium
    • Priority - KS:
      High
    • Priority - Rice:
      High
    • Theme:
      Ease of Implementation
    • Application Impact:
      Low
    • Effort Estimate:
      Low ~ 200 hrs

      Description

      A consistent documentation framework would include:
      1 Standard ways of documenting service contracts
      2 ER diagrams with explanatory text
      3 download and install instructions
      4 sample data sets
      5 usage notes

      And a master index of all Rice products

        Attachments

          Issue Links

            Activity

            Hide
            ewestfal Eric Westfall added a comment -

            Does the list of documentation framework components that Leo provides in the description constitute a rough approximation of what we think this roadmap item should encompass? Or is there more that we would like to include as part of this framework (i.e. tutorials).

            Show
            ewestfal Eric Westfall added a comment - Does the list of documentation framework components that Leo provides in the description constitute a rough approximation of what we think this roadmap item should encompass? Or is there more that we would like to include as part of this framework (i.e. tutorials).
            Hide
            sagee Sandra Agee (Inactive) added a comment - - edited

            Business Feature:
            -Provide technical documentation and provide a standard way of documenting service contracts
            -Provide consistency for technical documentation and releases

            High level Scope is confirmed:

            1 Standard ways of documenting service contracts
            2 ER diagrams with explanatory text
            3 download and install instructions
            4 sample data sets
            5 usage notes

            Show
            sagee Sandra Agee (Inactive) added a comment - - edited Business Feature: -Provide technical documentation and provide a standard way of documenting service contracts -Provide consistency for technical documentation and releases High level Scope is confirmed: 1 Standard ways of documenting service contracts 2 ER diagrams with explanatory text 3 download and install instructions 4 sample data sets 5 usage notes
            Hide
            ewestfal Eric Westfall added a comment -

            As Sandi mentions, I think this is primarily focused on a framework for technical documentation in the vein of the 5 high level scope items defined. Out of those, we have already identified (though still need to formally document) our process for documenting service contracts (thorough javadoc-ing of the jaxws-annotated services and jaxb-annotated beans). For number 2, we already have ERD for everything but we do need to work on a way to provide better "explanatory text". We already have download and install instructions on all Rice releases. We already produce sample data sets with each Rice release. Though they could be expanded.

            I think the area we are primarily lacking in are "usage notes". Though to some extent that's covered by documenting of service contracts, it should also include all of the non-service-based apis in Rice. Based on this analysis, I'm going to leave this estimate at around 200 hours.

            Show
            ewestfal Eric Westfall added a comment - As Sandi mentions, I think this is primarily focused on a framework for technical documentation in the vein of the 5 high level scope items defined. Out of those, we have already identified (though still need to formally document) our process for documenting service contracts (thorough javadoc-ing of the jaxws-annotated services and jaxb-annotated beans). For number 2, we already have ERD for everything but we do need to work on a way to provide better "explanatory text". We already have download and install instructions on all Rice releases. We already produce sample data sets with each Rice release. Though they could be expanded. I think the area we are primarily lacking in are "usage notes". Though to some extent that's covered by documenting of service contracts, it should also include all of the non-service-based apis in Rice. Based on this analysis, I'm going to leave this estimate at around 200 hours.
            Hide
            ewestfal Eric Westfall added a comment -

            Created subtasks for all of this stuff except for download and install instructions because i think we've got those taken care of pretty well already.

            Show
            ewestfal Eric Westfall added a comment - Created subtasks for all of this stuff except for download and install instructions because i think we've got those taken care of pretty well already.
            Hide
            jcoltrin Jessica Coltrin (Inactive) added a comment -

            removing myself as assignee

            Show
            jcoltrin Jessica Coltrin (Inactive) added a comment - removing myself as assignee

              People

              • Assignee:
                Unassigned
                Reporter:
                lfernig Leo Fernig (Inactive)
              • Votes:
                0 Vote for this issue
                Watchers:
                0 Start watching this issue

                Dates

                • Created:
                  Updated: