Skip to end of metadata
Go to start of metadata
UXI has established a process for adding and modifying components in the Kuali Design Guide.  This process ensures that all of the functional project teams are aware of the change and that it won't have a negative impact on their project or product.  Please read these steps before making changes to the Kuali Design Guide Documentation.

Process of creating a new component:


Phase 1 (Drafting)
  • Kuali contributor discovers a new component is needed and initiates the new component process
  • Initiator checks with Rice development team to discover whether anything currently exists and reconciles differences between any current implementation.
  • Initiator documents details of new component request in a UXI JIRA and a link to the JIRA is added in the component specification. 
  • Designer and/or developer do license checking if bringing in new software.  The JIRA will get assigned to a UX designer (if the person who initiated the request is a designer he/she will be assigned).
  • Designer builds out new component to his/her satisfaction and satisfaction of customer using a prototyping tool (such as Axure or Kuali MyBalsamiq, which can be easily shared with the project teams. Contact Heather Beery for access).
  • Designer will copy and complete a new component specification template and add the completed specification to the draft component specification area of the UXI wiki.  
  • The status of the specification is set to "Review"

Phase 2 (Review & Approval)
  • Designer reviews new component spec and prototypes with the UX Working Group (made up of the UXI team and designers and developers from other Kuali projects) and the UX Rice KRAD Working Group (made up of the UXI team, KS UX Core team, and Rice KRAD developers).
  • Designer makes necessary changes based on working group review.
  • UXI team completes code review for code snippets.
  • Component specifications that are ready are reviewed by the Kuali Application Integration Working Group (KAI) for cross-project functional impact.
  • When review is complete, the UXI JIRA is resolved/closed and is cloned into a Rice KRAD JIRA for new component development
  • Designer sets the status of the specification to "Approved"
  • KRAD prioritization committee determines when KRAD JIRA will be implemented

Phase 3 (Implementation)

  • When the KRAD JIRA is being worked on, designer sets the status of the specification to "Implementation"
  • Designer works with assigned developer on implementation of component. Designer communicates back to customer and design working group any changes necessary.

Phase 4 (Final)

  • Once the implementation is complete, designer sets status of specification to "Released"
  • Designer removes code snippets from specification document.
  • UXI moves the component specification from the Draft Component Specification area to the Kuali Design Guide Documentation
  • The Kuali Design Guide will pull in the updated documentation on a daily basis.



Process of modifying an existing component:

Phase 1 (Drafting)
  • Modifications to an existing component are requested
  • Designer determines changes needed to the component specification based on the previously documented component specification in the Kuali Design Guide
Phase 2 (Review)
  • Designer creates Rice KRAD Jira for component enhancement/bug
  • If it is a major change, the designer completes the review and approval process outlined above.  If it is a minor change, the designer will consult with UX colleagues and make an informed decision on the change (will bypass review team and KAI review).
  • UXI prioritization committee assigns JIRA

Phase 3 (Implementation)

  • Designer works with assigned developer on implementation of component if necessary. Designer communicates back to customer and design working group any changes necessary.

Phase 4 (Released)

  • UXI adds component documentation to Kuali Design Guide and documents the version change


  • No labels