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

Finish documentation for whole project #85

Open
A-Sandrini opened this issue Jul 24, 2022 · 0 comments
Open

Finish documentation for whole project #85

A-Sandrini opened this issue Jul 24, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation Est Size = 3 Real Size = 3

Comments

@A-Sandrini
Copy link
Collaborator

A-Sandrini commented Jul 24, 2022

User story

  1. As a developer
  2. I want / need to finish the documentation of the whole project
  3. So that everything can be presented on demo day and the repository is comprehensable later on

Acceptance criteria

  • Missing documentation added
  • Existing documentation checked for errors
  • Markdown used
  • Documentation tab in planning documents updated

Definition of done (DoD)

  • Everything is documented in Github
  • Documentation tab in the planning docs is filled
  • PDFs for the documentation created and uploaded to Deliverables folder
  • Files named and uploaded to sprint-13/{user|design|build}-documentation.pdf

Feature DoD

  • Feature has been fully implemented
  • All acceptance criteria were met
  • All tests are passing
  • No known errors
  • Documentation updated
  • Bill of materials updated

Sprint Release DoD

  • Feature has been fully implemented
  • Feature has been merged into the mainline
  • All acceptance criteria were met
  • Product owner approved features
  • All tests are passing
  • Peer code review passed
  • Developers agreed to release
  • Documentation updated
  • Bill of materials updated
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 Est Size = 3 Real Size = 3
Projects
None yet
Development

No branches or pull requests

4 participants