Fejlesztői dokumentáció
Sziasztok!
Adott egy saját fejlesztésű PHP MVC keretrendszerben megírt alkalmazás.
Eddig nem volt fejlesztői dokumentáció a keretrendszerhez sem.
A fejlesztői dokumentációnak mit kell tartalmaznia?
Minden controllert, model (metódusait) a hozzátartozó view-kal, sorba kell venni?
Vagy jobb ha általánosabb leírások vannak a conroller-ek model-ek, helper-ek, rout-olás stb. használatáról.
Hogy érdemes megcsinálni hogy minnél átláthatóbb legyen egy fejlesztőnek?
■ Adott egy saját fejlesztésű PHP MVC keretrendszerben megírt alkalmazás.
Eddig nem volt fejlesztői dokumentáció a keretrendszerhez sem.
A fejlesztői dokumentációnak mit kell tartalmaznia?
Minden controllert, model (metódusait) a hozzátartozó view-kal, sorba kell venni?
Vagy jobb ha általánosabb leírások vannak a conroller-ek model-ek, helper-ek, rout-olás stb. használatáról.
Hogy érdemes megcsinálni hogy minnél átláthatóbb legyen egy fejlesztőnek?
Webconf
Alapvetoen akkor jarsz jol, ha egyszeru peldakkal kezded, olyasmivel ami valoszinuleg felmerul kerdeskent. Pl:
- Hogyan allitom be a routingot?
- Hogyan kerdezek le adatot?
- Hogyan hozok letre templatet?
stb. Ha ez megvan, akkor mehetsz at a strukturalis leirasba, stb. ha van ra igeny.