diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..6ac921216462a16542ed4cb5ee8df72804f06d15 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Pilot Service Use Cases & User Stories + +This project contains use cases, user stories, and related documents for the practical evaluation of pilot service candidates. + +Pilot Committee meeting notes and project status can be found in the [Git Committee Notes](https://gitlab-beta.engr.illinois.edu/git-solutions-committee/git-committee-notes) project. + +For more information on using these projects, see the [Contribution Guide](CONTRIBUTING.md), or contact <git-pilot-participants@mx.uillinois.edu> + +## Project Structure + +### Resources + +Service documentation, migration guides, and links to external resources. Files arranged by topic. + +### Use Cases + +Formal descriptions of features or requirements and their evaluation criteria, beginning with a user story. Templates are available in the Template subdirectory. + +One use case per file. + +### User Stories + +Anecdotal service requirements. At minimum, each user story should contain a subject and action. User stories should contain a success indicator and rationale. If the level of need is known, user stories may use the MoSCoW scale (i.e., Must, Should, Could, Won't) as a general indicator. + +User stories are arranged topically by file, with each file containing several subcategories, and each subcategory containing one or more user story.