Files
roaauto/docs/README.md

1.8 KiB

docs/ — insight-uri de proiect ROAAUTO

Documentație tehnică concisă, minimalistă, descoperită în timp ce lucrăm la sarcini reale (nu documentație generică, nu ce e deja evident din cod).

Regulă: adaugă sau actualizează o notiță aici ori de câte ori descoperi ceva nou și ne-evident despre structura proiectului (flux ascuns, capcană, convenție, procedură/pachet cheie, tabel relevant) în timpul rezolvării unei sarcini. Nu re-documenta ce oricine ar afla citind codul în 30 de secunde.

Notițele sunt organizate pe fișiere separate, câte un subiect pe fișier (ex. flux-<nume-flux>.md, pachet-<nume-pachet>.md, tabele.md), nu un singur fișier uriaș.

Fișiere

Insight-uri valabile doar pentru ROAAUTO stau aici. Insight-urile valabile pe orice proiect ROA* (convenții, capcane de tooling) stau în COMUN/docs/ (repo separat, partajat) — vezi mai jos.

Specifice ROAAUTO

(niciunul încă — primele insight-uri de proiect au fost, până acum, toate transversale și au migrat în COMUN/docs/)

Partajate (COMUN/docs/, valabile pe toate proiectele ROA*)