[POs-part] Finalize wiki ready to be handed over to IP - Githubissues

amosproj / amos2022ss05-find-my-hearing-aid

MIT License

2 stars 1 forks source link

[POs-part] Finalize wiki ready to be handed over to IP #263

Closed codingwithelijah closed 2 years ago

codingwithelijah commented 2 years ago

User story

As a team
We want / need to provide a detailed documentation of our app that covers user, build & deploy and design documentation
So that the customer can further develop the app easily with all implicit knowledge being externalized

Further Description:

See also: #274

Acceptance criteria

[ ] Go through WIKI and restructure the paragraphs, change existing headlines if necessary [POs]
[ ] Update "User Documentation" [POs]
[ ] Update "README"-file [POs]

Definition of done (DoD)

It builds without errors
code has been reviewed
Build has been made and deployed on a testing environment
Code coverage >75%
All acceptance criteria were met
Documentation updated whenever needed within planning documents (Tabs: Bill of materials, Documentations)
Branch/feature was merged into dev and then main

DoD general criteria

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
Developers agreed to release
Introduction as only heading in design documentation (thanks to Leo)
also documentation regarding refactoring