This is an old revision of the document!
Aceasta este structura recomandată pentru documentația de proiect de pe paginile voastre de wiki. Este o structură minimală, sunteți liberi să adăugați capitole/subcapitole dacă considerați că este nevoie. Vă rugăm ca toată documentația să fie scrisă în limba Engleză
Nume proiect
Introducere
Prezentarea pe scurt a proiectului vostru:
- ce face
- care este scopul lui
- care a fost ideea de la care aţi pornit
- de ce credeţi că este util pentru alţii şi pentru voi
Descriere generală
O schemă bloc cu toate modulele proiectului vostru, atât software cât şi hardware însoţită de o descriere a acestora precum şi a modului în care interacţionează.
Exemplu de schemă bloc aici.
Hardware Design
Aici puneţi tot ce ţine de hardware design:
- listă de componente
- scheme electrice. Recomandăm să folosiți o aplicație dedicată pentru desenarea schemei electrice (KiCAD, Altium, Fusion360 etc.) sau, în cel mai rău caz, o diagramă desenată în Fritzing, Wokwi sau Tinkercad.
- diagrame de semnal
- rezultatele simulării din Wokwi sau Tinkercad (dacă este posibilă simularea).
Software Design
Descrierea codului aplicaţiei (firmware):
- mediu de dezvoltare (if any) (e.g. AVR Studio, PlatformIO)
- biblioteci şi surse 3rd-party folosite (e.g. Procyon AVRlib)
- algoritmi şi structuri pe care plănuiţi să le implementaţi
- (etapa 3) surse şi funcţii implementate
Rezultate Obţinute
Care au fost rezultatele obţinute în urma realizării proiectului vostru.
Concluzii
Cod sursă și alte resurse ce trebuie să existe pe GitHub
Codul sursă trebuie urcat într-un repo public, recomandăm GitHub.
Structurați-vă pagina de GitHub a proiectului pe mai multe directoare. De exemplu, creați un director numit src în care țineți tot codul sursă. Alt director hardware în care să țineți schemele și diagramele și alt director numit images în care să puneți toate fotografiile cu proiectul vostru, pe care le link-ați în README.md
Pagina de GitHub a proiectului vostru trebuie să conțină toate fișierele relevante pentru realizarea proiectului vostru. Dacă există resurse externe pe care le-ați folosit, vă rugăm să le link-ați în README.md
Sunteți încurajați să filmați un demo cu proiectul vostru și să îl încărcați pe YouTube. Faceți embed la video în README.md și în pagina de wiki OCW a proiectului vostru.
Jurnal
Puteți avea și o secțiune de jurnal în care să poată urmări asistentul de proiect progresul proiectului.
Bibliografie/Resurse
Listă cu documente, datasheet-uri, resurse Internet folosite, eventual grupate pe Resurse Software şi Resurse Hardware.
