–Documentaci\u00f3 t\u00e8cnica<\/strong>: acompanya al programari i descriu diversos aspectes del seu funcionament. Documenta el codi, els algoritmes, les interf\u00edcies i APIs. La documentaci\u00f3 t\u00e8cnica pot ser utilitzada pels desenvolupadors, provadors i tamb\u00e9 pels clients finals. Diverses eines com Doxygen, Ndoc, RoboDoc, etc. permeten generar autom\u00e0ticament documentaci\u00f3 a partir del codi font i crear manuals de refer\u00e8ncia en formes com ara arxius de text o HTML .<\/p>\n \n Captura de pantalla del projecte del sistema operatiu Chromium<\/p>\n \u00a0 – Requisits de software<\/strong>: els requisits s\u00f3n la descripci\u00f3 del que un programari far\u00e0 o no far\u00e0 i s\u00f3n declaracions que identifiquen atributs, capacitats, caracter\u00edstiques o qualitats d’un sistema. Els requisits afecten tots els agents involucrats en la producci\u00f3: usuaris, clients, gerents, vendes, m\u00e0rqueting, arquitectes de programari, enginyers d\u2019usabilitat, dissenyadors d\u2019interacci\u00f3, desenvolupadors, etc. Es mostren en varietat d\u2019estils i notacions i poden ser especificats com a declaracions de llenguatge natural, f\u00f3rmules matem\u00e0tiques, dibuixos o totes aquestes combinades. La necessitat de documentaci\u00f3 dels requisits est\u00e0 relacionada amb la complexitat del producte i el seu impacte.<\/p>\n – Documentaci\u00f3 per a l\u2019usuari final<\/strong>: s\u00f3n els manuals per a l’usuari final, administradors de sistemes i personal de suport i expliquen com funciona el programa. El manual descriu cada funci\u00f3 del programa i ajuda l\u2019usuari, i tamb\u00e9 pot proporcionar assist\u00e8ncia per solucionar problemes m\u00e9s a fons. \u00c9s molt important que els documents d’usuari estiguin al dia. Tot i que no necessiten estar organitzats d’una manera determinada, \u00e9s important que tinguin un \u00edndex exhaustiu. La documentaci\u00f3 de l’usuari es considera que constitueix un contracte que especifica qu\u00e8 far\u00e0 el programari. Les tres formes b\u00e0siques de la documentaci\u00f3 d\u2019usuari s\u00f3n el tutorial, l\u2019enfocament tem\u00e0tic i la llista de refer\u00e8ncia.<\/p>\n – Documentaci\u00f3 de m\u00e0rqueting<\/strong>: per a determinades tipologies de programari \u00e9s necessari disposar de diferents materials promocionals. La documentaci\u00f3 informa qu\u00e8 fa el producte exactament i impel\u00b7leix el possible comprador a comprar-lo.<\/p>\n \n Programari lliure <\/strong><\/p>\n En relaci\u00f3 amb la documentaci\u00f3 de programari lliure es considera que sovint els manuals i la documentaci\u00f3 disponible \u00e9s incompleta o de baixa qualitat. \u00c9s a dir, de vegades el problema no \u00e9s el programari lliure en si, sin\u00f3 la documentaci\u00f3 que l\u2019acompanya. Sense una documentaci\u00f3 completa i fiable, el proc\u00e9s de creaci\u00f3 de programari \u00e9s incomplet. Com a soluci\u00f3 es proposa la utilitzaci\u00f3 d\u2019una llic\u00e8ncia de programari lliure com la del sistema operatiu GNU: https:\/\/www.gnu.org\/licenses\/fdl-1.3.en.html<\/a>. GNU tamb\u00e9 ofereix a la seva plana web una llista de llic\u00e8ncies lliures per a documentaci\u00f3 de programari: https:\/\/www.gnu.org\/philosophy\/license-list.html#FreeDocumentationLicenses<\/a>.<\/p>\n \n Recursos sobre documentaci\u00f3 de programari<\/strong><\/p>\n – Enlla\u00e7os:<\/p>\n Beautiful docs<\/a>: Llista col\u00b7laborativa de recursos per a la creaci\u00f3 de documentaci\u00f3 de programari que s\u2019actualitza regularment. Cont\u00e9 enlla\u00e7os per escriure documentaci\u00f3 i eines per generar documentaci\u00f3.<\/p>\n Software Documentation.info<\/a>: Plana web extensa dedicada a la documentaci\u00f3 de programari. Ofereix eines i recursos per a la documentaci\u00f3.<\/p>\n Categoria de documentaci\u00f3 de programari a Viquip\u00e8dia<\/a>: Inclou recursos i enlla\u00e7os a programes, eines, projectes i articles sobre la documentaci\u00f3.<\/p>\n A begginers guide to write documentation<\/a>: Lloc web amb informaci\u00f3, recursos, f\u00f2rum de documentalistes que serveix com a punt de trobada de documentalistes de programari. Peri\u00f2dicament organitzen trobades professionals i confer\u00e8ncies.<\/p>\n Perfils de Twitter que parlen sobre documentaci\u00f3:<\/p>\n @ericholscher <\/a><\/p>\n @troyhoward<\/a><\/p>\n @coderoshi<\/a><\/p>\n @writethedocs<\/a><\/p>\n \n \n Bibliografia: <\/strong><\/p>\n McConnell\u2019s, Steve. Code complete. A PracticalHandbook of Software Construction<\/em>. 2a ed. EUA: Microsoft books, 2004. 960 p.ISBN-10: 0735619670.<\/p>\n Yevgeniy Brikman<\/a>. You are what you document<\/em>. http:\/\/brikis98.blogspot.de\/2014\/05\/you-are-what-you-document.html<\/a>. [Acc\u00e9s: 1 de juny del 2014]: Ampli article que recull multitud d\u2019enlla\u00e7os i casos pr\u00e0ctics ordenats segons categories i temes. Software documentation.<\/p>\n http:\/\/en.wikipedia.org\/wiki\/Software_documentation<\/a>. [Data de consulta: 30 de maig del 2014]. Why Free Software needs Free Documentation. https:\/\/www.gnu.org\/philosophy\/free-doc.en.html<\/a>. [Data de consulta: 1 de juny del 2014]. Documentaci\u00f3 de programes en programari lliure.<\/p>\n![\"chromium\"](\"http:\/\/multimedia.uoc.edu\/blogs\/documentacio\/files\/2014\/09\/chromium.png\")
<\/a><\/p>\nYevgeniy Brikman<\/a>. Youarewhatyou document<\/em>. http:\/\/brikis98.blogspot.de\/2014\/05\/you-are-what-you-document.html<\/a>. [Data de consulta: 1 de juny del 2014]: Ampli article que recull multitud d\u2019enlla\u00e7os i casos pr\u00e0ctics ordenats segons categories i temes. \u00c9s un article interessant per iniciar-se en el tema.<\/strong><\/h3>\n