Revizia anterioară Revizia următoare
Tutorial pentru scrierea articolelor
Ne bucuram ca ai ajuns aici si vrei sa contribui la continutul educational al site-ului. Aceasta pagina se vrea un ghid rapid si eficient care sa te puna la treaba. Poti sa citesti inainte si despre Textile si conventiile de formatare pe care le utilizam, dar crearea unui articol este mult mai simpla si mai frumoasa decat acele seturi de reguli. :)
Structura articolului
Mai mult ca sigur ca ai un plan pe care vrei sa-l urmezi in scrierea articolului. Punerea lui pe infoarena este cu atat mai simpla. Tot ce trebuie sa faci este sa copii continutul paginii Structura articol in pagina articolului tau, iar apoi sa il adaptezi in functie de titlu, numele tau si sectiunile articolului. Dupa cum observi in structura, e foarte important sa ai un cuprins care sa-i ajute pe utilizatori sa se duca direct la tinta in articolul tau.
Referitor la structura, iti facem si cateva recomandari care vor pune in valoare munca ta:
* Mentine sectiunile de cel mult 1 pagina pentru a fi usor de urmarit.
* Propune-i cititorului o lista de probleme care il poate ajuta in intelegerea subiectului abordat.
* Include la sfarsit si o lista bibliografica cu sursele din care te-ai documentat.
TODO
- Unele articole vor necesita formule mai frumoase. Poti alege sa le scrii normal (daca nu sunt asa complexe), sa le scrii cu LaTeX, sau hibrid. Pentru ultima varianta, ai grija, totusi, sa se imbine elegant cele doua portiuni.
Formatarea codului
In caz ca incluzi in articolul tau bucati de cod, ar fi indicat:
- sa folosesti nume de variabile sugestive
- sa faci indentare cu 4 spatii (nu tab-uri)
- sa eviti macro-urile, folosind in schimb constante, typedef-uri si functii inline
- sa aerisesti codul prin separarea operatorilor de restul codului prin spatii (de exemplu, o atribuire ar arata sub forma A = B; totusi o incrementare se scrie legat ++i)
- sa te asiguri ca nu ai probleme la compilarea codului
Acestea fiind zise, spor la treaba!
