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

[UC Template] "What to be done?" is ambiguous #287

Open
mmccool opened this issue May 9, 2024 · 2 comments
Open

[UC Template] "What to be done?" is ambiguous #287

mmccool opened this issue May 9, 2024 · 2 comments
Labels

Comments

@mmccool
Copy link
Contributor

mmccool commented May 9, 2024

The question "What to be done?" is ambiguous. Is this supposed to be a summary of the use case, or a summary of the changes needed to WoT to address the use case, or the existing features in WoT used for the use case, or something else?

Suggest changing this to "Summary" and ask for a short overview of the use case - an abstract of the longer description given later. Text explaining the purpose of this should be "Please provide a short (2-3 sentence) summary of your use case."

Then the "Gaps" should be moved up to just under "Why WoT"? (Should also be titled "Gaps between the user's need and what's possible today in WoT" (the "in WoT" is important).

@mmccool mmccool added the Process label May 9, 2024
@chachamimm
Copy link
Collaborator

chachamimm commented May 14, 2024

I'm ok with the following order:

  1. Summary
  2. Description
  3. Why WoT
  4. Gaps between the user's need and what's possible today in WoT

After changing the order of those items, we should put a nicer title to the section (Maybe "Use Case Description and Expectations" still works well.)

@mmccool
Copy link
Contributor Author

mmccool commented May 15, 2024

Prefer the order Summary, Why WoT, Gaps, Description. This is because Description can be long, and it would be nice to see a short overview at the top.

chachamimm added a commit that referenced this issue Jun 18, 2024
…287

Based on the discussion results of "What to be done?" is ambiguous - #287, I change the order of item of sample-usecase-template.yml.

   * Summary
   * Why WoT
   * Gaps
   * Description
chachamimm added a commit that referenced this issue Jul 19, 2024
Based on the discussion results of ["What to be done?" is ambiguous #287](#287), I change the order of item of WoT-UseCases-Template.yml.

Summary
Why WoT
Gaps
Description
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants