Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

About Ed-Fi Tracker

TODO: Expand this section.

The Ed-Fi Alliance tracks issues and feature requests in JIRA. This allows the Ed-Fi Community to:

...

Expand
titleNew Feature Requests User Story

New Feature Requests User Story

Writing a User Story

When submitting a feature request, it is standard practice in Agile development to do so in the form of a "user story." A user story is a simple account of a feature told from the perspective of a user that is designed to ensure that requests are communicated with the baseline data needed for a developer and others to quickly understand the feature and why it is needed. A user story look like this:

As a {type of user},

I want {goal}

because {reason}.

The parts of a user story:

  • {type of user} - Identify who the specific user type is, as in "As a classroom teacher..." or "As the system database administrator...". A not so good example would be "As a user of the software...". If there is a characteristic that is critical to understanding this user, include that too: "As a classroom teacher who is using this software for the first time...".
  • {goal} - Say what the user is trying to do or accomplish. Try to describe the interaction as an outcome or goal, and resist describing it as a series of steps. "As a classroom teacher, I want to download the assessment results in text file format...".
  • {reason} - Say why the user wants to accomplish the goal

A full example would be:

As a classroom teacher,

I want to download the assessment results in text file format

because I may not have Excel or other required software applications installed on my computer.

Entering User Stories in Tracker

When submitting a feature request in Jira, put the whole user story in the "Summary" field.  A user story is designed to be a short but effective vehicle for communicating a need at a glance so others can see what is wanted, who needs it, and why. This allows it to be understood, sorted, voted on, etc. very quickly.

Entering Descriptive Details and Acceptance Criteria in Tracker

In the "Description" field, you can add any additional details you feel are important, or make suggestions as to the best way to supply this feature. Given the user story above, you might write: "Many teachers are using Google Docs instead of Microsoft Office, so when files are downloaded in Excel format they have trouble opening them" or "I think a drop-down offering an Excel and Text file options in the left corner would be best.".

Finally, one best practice we recommend is to add to the description what is called "acceptance criteria." Acceptance criteria are suggestions designed to let the software developer know when the story is complete. To continue the example above, what if the teacher is able to download the assessment results, but her computer does not recognize the file as a text file? An acceptance criteria to fix this might look like this: 

When the file is downloaded, please ensure that it is recognized by the system as a text file and opens in the right application (e.g,. put a ".txt" on it, etc), including on my iPad.

This gives the developer who handles this story a list of specific item to test to ensure the story was completed successfully.

Info

You may also want to use visual panels to communicate related information, tips, or things users need to be aware of.


DATASTD Tracker

...

Ticket Status Workflow

The life of a DATASTD ticket has many phases. To help understand the process, below is the overall workflow for the DATASTD tracker project followed by a few common paths DATASTD tickets take.

Image Added

OPEN

All DATASTD tracker tickets are created with the OPEN status. In this phase, the a reporter can expect from the community additional information gathering, suggested best practices or workarounds, background information, and/or clarifications, depending on the nature of the ticket. If there exists related tickets they may be linked and the community can vote on tickets they'd like to see gain more visibility. From there, they have two possible paths: Under Analysis and Closed. Periodically the Alliance and other community groups will review suggestions for changes to the data standard. When a ticket has been selected for this process, it is moved from OPEN to UNDER ANALYSIS. Those tickets that are resolved without requiring any further discussion or changes to the data standard will be CLOSED.

UNDER ANALYSIS


PLANNED FOR DEVELOPMENT


IN DEVELOPMENT


READY FOR REVIEW


SCHEDULED FOR RELEASE


CLOSED


Tracker Ticket Stories

Best Practices and Clarification

TODO: Insert an example of a ticket that is requesting the best way to store data elements. How to record multiple course parts in the StudentAcademicRecord and CourseTranscript is an example of this.

Reporting a Bug

TODO: Insert an example of a ticket that is requesting a fix for data that is currently included in the data standard. The StudentProgramAttendanceEvent needing a StudentProgramAssociation is an example of this. StartTime and EndTime for CalendarDate is another.

New Feature Request

TODO: Insert an example of a ticket that is requesting a new feature to the data standard. Adding EnrollmentType to the StudentSchoolAssociation is an example of this. Can mention that multiple state implementations have added elements for this as extensions.