#148 Cuprins documentaţie
state: closed opened by: adrianharabula on: 5/28/2017
Un exemplu complet a ceea ce trebuie noi să avem la sfârşit este un proiect din anii trecuţi ce se află aici, de pe vremea când corecta buraga priectele.
Documentaţia noastră va avea de asemenea 2 părţi (2 documente diferite):
Manualul utilizatorului
exemplu live aici, documentul nostru aici
- luăm fiecare pagină în parte şi o povestim
- povestim userului normal aplicaţia
Manualul programatorului / dezvoltatorului
exemplu live aici, documentul nostru aici
1. Explicarea bazei de date
Acestea subliniate vor rămâne neschimbate 100% pe perioada dezvoltării proiectului.
Tabela categories
Tabela companies
Tabelele condrgroup şi condrgroup_user (relaţie many to many între ele)
Detalii aici https://laravel.com/docs/5.4/eloquent-relationships#many-to-many
Tabelele products şi product_user (relaţie many to many între ele)
Detalii aici https://laravel.com/docs/5.4/eloquent-relationships#many-to-many
Tabela users
Tabela search analitics
Aici înregistrăm toate keywords căutate şi facem statistici după ele
2. Detalii de implementare
3. Server related stuff
Comments
from: adrianharabula on: 5/28/2017
Aici aveţi bibliografie pentru cum să faceţi documentaţie bine:
- nişte slideuri succinte şi foarte bune http://www.writethedocs.org/_downloads/docs_talk.pdf
- documentaţie, ce este ea şi la ce foloseşte explicată pe îndelete http://www.writethedocs.org/guide/writing/beginners-guide-to-docs/
from: adrianharabula on: 5/28/2017
Plus Readme driven development
from: adrianharabula on: 6/6/2017
Avem documentaţia tehnică disponibila online aici.