Documentatie in imagini

Astazi vreau sa vorbesc un pic despre defectele mele ca programator.

Documentatie in imagini



Astazi vreau sa vorbesc un pic despre defectele mele ca programator.

Sunt un programator usor lenes.

Nu imi place sa petrec timp facand debugging extensiv.
Nu imi place sa dezvolt tot felul de hack-uri pentru integrare. Sunt prea lenes sa dezvolt solutii temporare pentru ca oricum se va reveni asupra lor mai tarziu. Nu imi place sa petrec timp explicand arhitectura unei componente din sistem developerilor care lucreaza pe platforme diferite.

Sunt o persoana vizuala dar nu pot sa desenez foarte bine.

Imi este mai usor sa inteleg informatia atunci cand este prezentata in imagini in loc sa citesc pagini peste pagini de text. Nu sunt foarte bun la desen si nu prea am chef sa imi instalez programe sofisticate.

Uneori sunt retrograd.

Imi plac lucrurile mai vechi dar care si-au demonstrat valoarea in timp. Imi place ca programele pe care le folosesc sa fie precise deoarece sunt prea lenes sa rezolv incertitudinile. Si imi place si cand schimbarile in documentatie sunt usor de urmarit.

Astfel pe baza experientei mele profesionale si a trasaturilor mele am ajuns la concluzia ca cea mai buna metoda de a dezvolta documentatia si de a o distribui developerilor, project/product managerilor si echipei de QA este prin intermediul unor resurse grafice.

Solutie.

Cautand pe Internet o solutie la provocarea mea m-au ajutat destul de mult Graphviz si DOT. Folosind limbajul DOT puteti sa descrieti cu usurinta diagrame si grafice care sa reprezinte arhitectura unor componente similare pentru web, iOs si Android si apoi sa exportati in ce format doriti – png/svg/jpeg. Sunt foarte multe pluginuri pentru DOT: pentru IDE sau pentru servicii web precum Confluence. Si asta inseamna ca poti sa vizualizezi un document nu doar din linia de comanda ci si din interiorul aplicatiilor standard.

In afara de asta DOT este foarte bun pentru a descrie FSM (finite state machines). Si bineinteles din moment ce DOT este un limbaj, orice schimbari dintr-un fisier text ce contine o descriere a componentei cu orice version of control va fi reparat automat.

Mai jos este ce putem face cu DOT si Graphiz.

Documentation in Pictures.jpg


Si iata si reprezentarea textuala:

Documentation in Pictures_2.png

Aceasta abordare m-a ajutat de foarte multe ori atat in procesul de dezvoltare cat si in facilitarea prezentarilor. Folosind acest instrument am reusit sa fac usor si rapid o diagrama / flowchart si sa fac schimbarile necesare. Limbajul DOT este simplu si usor de invatat.

Mai mult imi place faptul ca ma pot concentra pe continut si nu pe reprezentare – toate elementele vor fi desenate si vor fi aranjate automat si nu va trebui sa rearanjati blocurile dupa ce faceti schimbari.

Ivan Alyakskin 
Software Consultant

Daca-ti place acest articol, distribuie-l si prietenilor tai!

Contacts in

loading map...
Dimitrie Pompeiu nr 5-7 , building C, Et. 5, sect 2, Bucharest, 014459

Contact phone:

021 371 4858
loading map...
Luxoft Poland Wrocław - Silver Tower pl. Konstytucji 3-go Maja 3 50-048 Wrocław
loading map...
Aleja Generała Tadeusza Bora-Komorowskiego 25, Quattro Business Park Five, 31-476 Kraków, Poland

Contact phone:

+48 122110650
   Aboneaza-te la newsletterul nostru lunar
Success
Iti multumim.
Inregistrarea ta a fost trimisa.