search

cvlab-ai / polish_banknotes

Czytnik Polskich Banknotów is a mobile app for detecting polish banknotes using neural networks
GNU General Public License v3.0
8 stars 2 forks source link

Dokumentacja projektowa #14

Closed jankejc closed 1 year ago

jankejc commented 1 year ago

Przegląd

Wątek będzie poświęcony wymaganej dokumentacji. Stworzone branche będą dawały możliwość stałego zapisywania "logów swojej pracy". Jest to niezbędne do późniejszego prostszego przełożenia podjętych działań na dokument. Po każdym podjętym działaniu zostawmy po sobie choćby ślad.

jankejc commented 1 year ago

Jako, że część dokumentacji będzie wspólna myślę, że stworzymy 3 branch'e. Jeden np. main_doku, drugi android_doku i trzeci ios_doku? (do zatwierdzenia)

qaziok commented 1 year ago

Na githubie mamy włączona taką zakładkę jak Wiki, jeśli chcesz coś dłużej trzymać i dokumentować tam jest to bardzo dobre miejsce na to

jankejc commented 1 year ago

To by było spoko, tylko ja chciałem, żebyśmy w branchach już edytowali gotowe szablony dokumentacji, czyli tak naprawdę wypełniali szkielet. W zakładce, z tego co widzę i coś tam czytam na szybko, to raczej buduje się doku od zera. W takiej sytuacji myślę, że możemy podjąć jeden z dwóch kierunków. Albo robimy to tutaj wypełniając gotowe schematy, albo "logujemy" wszystko w wiki i ostatecznie też pewnie robimy jakiś issue, żeby to wszystko zmergować.

qaziok commented 1 year ago

Rozumiem zamysł, ogólnie propsy że już o dokumentacji myślisz xd, jednak osobiście nie jestem przekonany żeby to w branchach trzymać, myślę że tamat do większej dyskusji

anton-0 commented 1 year ago

Spoko pomysł, żeby to na bieżąco dokumentować, ale bardziej bym się skłaniał ku trzymaniu tego w Wiki.

jankejc commented 1 year ago

Myślę, że okej. Wtedy będziemy logować swoją pracę w wiki, a potem spróbujemy to wszystko zebrać. => Dokumentacja przejdzie do wiki - jest już issue, który się tym zajmuje. Tym samym zamykam obecny wątek.