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

[UserStory] Creating documentation for users #133

Open
1 of 5 tasks
CamiJolly1 opened this issue Nov 14, 2023 · 1 comment
Open
1 of 5 tasks

[UserStory] Creating documentation for users #133

CamiJolly1 opened this issue Nov 14, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation epic Epic question Further information is requested user story User Story

Comments

@CamiJolly1
Copy link
Contributor

CamiJolly1 commented Nov 14, 2023

User Story

Essential components

  • Title describes the story
  • Stakeholder type is identified
  • Outcome is described
  • Rationale is explicit
  • Acceptance criteria are verifiable and from the perspective of the stakeholder

Story

As a user
I want documentation
so that to know how to navigate using ImageLab

Acceptance Criteria

  • This documentation should be linked or included on the website for ImageLab

Supporting Information

ImageLab lacks documentation, which can make it difficult for users or new contributors to know what is and isn't possible when using the program.

Dependencies

Dependents

@CamiJolly1 CamiJolly1 added the user story User Story label Nov 14, 2023
@CamiJolly1 CamiJolly1 changed the title [UserStory] creating documentation for users [UserStory] Creating documentation for users Nov 14, 2023
@jody
Copy link
Contributor

jody commented Nov 20, 2023

Both the story and the acceptance criteria are just a bit too vague to be used as is.

We need to provide more detail for a developer to know what to do and a reviewer to know when the goal has been accomplished.

For now will mark this as an epic, needing to be broken into smaller and more well-defined parts.

@jody jody added documentation Improvements or additions to documentation question Further information is requested epic Epic labels Nov 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation epic Epic question Further information is requested user story User Story
Projects
Status: To do
Development

No branches or pull requests

2 participants