best-practices.md

Linkkejä hyviin käytänteisiin

Näistä vanhojen ohtuprojektin artefakteista voi ottaa mallia omaa projektia varten. Älä kuitenkaan kopioi suoraan vaan pohtikaa mitä teidän projektinne ja tiiminne tarvitsee. Voit myös lisätä vinkkejä tekemällä pr!

Development workflown kuvaaminen

• https://github.com/OhtuKisalli/project-info/blob/master/workflow.md

Backlog

Product backlog

Ajan kuluessa GitHub Projects on saavuttanut suosiotaan niin product kuin sprint backlogien alustana. Tässä pari esimerkkiä näistä

• https://github.com/orgs/Anturit/projects/2/views/1
• https://github.com/orgs/marjanpoimijat/projects/3

Toinen suosittu alusta backlogeille on ollut Google Sheets.

• https://docs.google.com/spreadsheets/d/1a6bmQr5vvjFKoaNGr8-ilExtwjr2A6OBHpKnpp8d45Y/edit#gid=0

Sprint backlog

Sprintti 1 aika hyvä, sprintin 2 taskijako voisi olla hienosyisempi:

• https://docs.google.com/spreadsheets/d/1a6bmQr5vvjFKoaNGr8-ilExtwjr2A6OBHpKnpp8d45Y/edit#gid=166436744

Loistava taskijako sprintissä 1:

• https://docs.google.com/spreadsheets/d/1cA-ldx-M_ppxSicxjL06BmAjhoNi5I55M5BugoUBD98/edit#gid=1159093674

README.md

Ehkä overall paras tähänastinen

• https://github.com/OhtuKisalli/project-info

Oikeaoppinen development-ohje

• https://github.com/ohtu2018-rv/rv-backend

Työaikakirjanpito

• https://docs.google.com/spreadsheets/d/17PduZQHrmnuX6p_RP01JO7bq5TDrcI7-3gSi1h1wwI4/edit?ts=5a5c6da6#gid=1685552279

Dokumentaatio

Definition of Done

Riittävän perusteellinen sen suhteen että asioista on mahdollista todeta ovatko ne "done"

• https://docs.google.com/document/d/1eTyUjT8rQvBWOGFAobeOJKGN3qU0LiBdK6p5i7BTWTQ/edit

REST-apin kuvaus

Muuten esimerkillinen mutta formaatiksi sopisi paremmin githubin markdown:

• https://docs.google.com/document/d/1NivINt2Pj7I66VPD99HeDnT9LGFb32-2YCBa1Jmjv8w/edit

Usecasejen kuvaus

• https://drive.google.com/drive/folders/0B1wLG72sys_SQVBKSGFpNTJmX1E

Arkkitehtuuri

Melko perusteellinen, jopa hieman raskaahko dokumentti

• https://docs.google.com/document/d/1MkSI6UdJo2KNHohv3ef9ym2W6n7OzVb3rv0yaz3nDZQ/edit

Tiivis mutta informatiivinen

• https://github.com/kehitysto/coaching-chatbot/blob/master/doc/architecture.md

Development / Build pipeline arkkitehtuurikaavio

• 404

Käyttöönotto-ohje

• https://github.com/kehitysto/coaching-chatbot/blob/master/doc/deploy-instructions.md

Testaus

Tiivis mutta aikalailla riittävä

• https://github.com/kehitysto/coaching-chatbot/blob/master/doc/testing-instructions.md

Olisi toki hyvä luonnehtia myös jos jokin osa ohjelmistosta jää automaattisen testauksen ulkopuolelle