Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update use-case-template.md #25

Merged
merged 1 commit into from
Feb 11, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 21 additions & 5 deletions .github/ISSUE_TEMPLATE/use-case-template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Use case template
about: Template used to define use case
about: Template used to define a use case
title: ''
labels: ''
assignees: ''
Expand All @@ -9,17 +9,33 @@ assignees: ''

## Introduction

Brief introduction of the use case.
Recommend format: As a <Reader | who will benefit from the use case> I would like to <what is the use case> so that <how will benefit from the use case>
Brief introduction to the "use case template".<br/><br/>

This template might serve as an approach to document use cases in a more systematic and coherent way.

The expressions in angle brackets are meant to be *placeholders* for the specific content of a use case. The description should be technology-agnostic as it serves to define the users' needs and will not be a guide for a specific implementation.<br/><br/>

1. <Reader | who will benefit from the use case>: <br/>
Here you should try to define the *role* of the user as precisely as possible. For example, instead of "as a publisher" you might say "as a publisher of scientifc textbooks" etc. Please keep in mind that a Reading System could also be a kind of user.<br/><br/>

2. &lt;what is the use case&gt;: <br/>
Try to describe your user's need as precisely as possible on a micro-level that could be implemented later on. Instead of a general statement such as "achieve a more user-friendly layout", you should prefer to speak of "achieve a more flexible table layout for huge and complex tables". <br/><br/>

3. &lt;how I will benefit from the use case&gt;:<br/>
Describe the ultimate goal of the user's requirement. For example, if you requested "a more flexible table layout for huge and complex tables", you might want to adapt for mobile use - "so that you may consume them on a mobile".<br/><br/>

Recommended format:<br/><br/>
As a &lt;Reader | who will benefit from the use case&gt; I would like to &lt;what is the use case&gt; so that &lt;how I will benefit from the use case&gt;


## Detail

* What is the current problem.

More specific is better to help people understand.

* If the use case has specific audience or circumstance then who, when and how will people benefit from solving this problem.
* If the use case has a specific audience or circumstance, then who, when and how will people benefit from solving this problem.

## Proposal (if any)

Use case does not need to come with proposal or recommendation. But if there is any we can have it documented.
A use case does not need to come with a proposal or a recommendation. But if there is any, we can have it documented.