–Documentaci\u00f3n t\u00e9cnica<\/strong>: Acompa\u00f1a al software y describe varios aspectos de su funcionamiento. Documenta el c\u00f3digo, algoritmos, interfaces y API. La documentaci\u00f3n t\u00e9cnica puede ser utilizada por los desarrolladores, probadores y tambi\u00e9n por los clientes finales o clientes. Varias herramientas, como Doxygen, Ndoc, RoboDoc, etc., permiten generar autom\u00e1ticamente documentaci\u00f3n a partir del c\u00f3digo fuente y crear manuales de referencia en formas como por ejemplo archivos de texto o HTML.<\/p>\n \n Captura de pantalla del projecte del sistema operatiu Chromium<\/p>\n \u00a0 – Requisitos de software<\/strong>: Los requisitos son la descripci\u00f3n de lo que un software har\u00e1 o no har\u00e1 y son declaraciones que identifican atributos, capacidades, caracter\u00edsticas o cualidades de un sistema. Los requisitos afectan a todos los agentes involucrados en la producci\u00f3n: usuarios, clientes, gerentes, ventas, marketing, arquitectos de software, ingenieros de usabilidad, dise\u00f1adores de interacci\u00f3n, desarrolladores, etc. Se muestran en una variedad de estilos y notaciones y pueden ser especificados como declaraciones de lenguaje natural, f\u00f3rmulas matem\u00e1ticas, dibujos o todas ellas combinadas. La necesidad de documentaci\u00f3n de los requisitos est\u00e1 relacionada con la complejidad del producto y su impacto. <\/p>\n – Documentaci\u00f3n para el usuario final<\/strong>: Son los manuales para el usuario final, administradores de sistemas y personal de soporte, y explican c\u00f3mo funciona el programa. El manual describe cada funci\u00f3n del programa y ayuda al usuario, al tiempo que puede proporcionar asistencia para solucionar problemas m\u00e1s complejos. Es muy importante que los documentos de usuario est\u00e9n al d\u00eda. A pesar de que no necesitan estar organizados de una manera determinada, es importante que tengan un \u00edndice exhaustivo. La documentaci\u00f3n del usuario se considera que constituye un contrato que especifica lo que el software har\u00e1. Las tres formas b\u00e1sicas de la documentaci\u00f3n de usuario son el tutorial, el enfoque tem\u00e1tico y la lista de referencia. <\/p>\n – Documentaci\u00f3n de marketing<\/strong>: Para determinadas tipolog\u00edas de software es necesario disponer de diferentes materiales promocionales. La documentaci\u00f3n informa de lo que hace el producto exactamente e impele al posible comprador a su compra.<\/p>\n \n Software libre <\/strong><\/p>\n En relaci\u00f3n con la documentaci\u00f3n de software libre, se considera que a menudo los manuales y la documentaci\u00f3n disponible es incompleta o de baja calidad; es decir, a veces el problema no es el software libre en s\u00ed, sino la documentaci\u00f3n que lo acompa\u00f1a. Sin una documentaci\u00f3n completa y fiable, el proceso de creaci\u00f3n de software es incompleto. Como soluci\u00f3n se propone la utilizaci\u00f3n de una licencia de software libre como la del sistema operativo GNU: https:\/\/www.gnu.org\/licenses\/fdl-1.3.en.html<\/a>. GNU tambi\u00e9n ofrece en su p\u00e1gina una lista de licencias libres para documentaci\u00f3n de software: https:\/\/www.gnu.org\/philosophy\/license-list.html#FreeDocumentationLicenses<\/a>.<\/p>\n \n Recursos sobre documentaci\u00f3n de software<\/strong><\/p>\n – Enlaces:<\/p>\n Beautiful docs<\/a>: Lista colaborativa de recursos para la creaci\u00f3n de documentaci\u00f3n de software que se actualiza regularmente. Contiene enlaces para escribir documentaci\u00f3n y herramientas para generar documentaci\u00f3n. <\/p>\n Software Documentation.info<\/a>: Extensa p\u00e1gina dedicada a la documentaci\u00f3n de software, ofrece herramientas y recursos para la documentaci\u00f3n. <\/p>\n Categoria de documentaci\u00f3 de programari a Viquip\u00e8dia<\/a>: Incluye recursos y enlaces a programas, herramientas, proyectos y art\u00edculos sobre la documentaci\u00f3n.<\/p>\n Yevgeniy Brikman<\/a>. Youarewhatyou document<\/em>. http:\/\/brikis98.blogspot.de\/2014\/05\/you-are-what-you-document.html<\/a>. [Fecha de consulta: 1 de junio de 2014]: Amplio art\u00edculo que recoge multitud de enlaces y casos pr\u00e1cticos ordenados seg\u00fan categor\u00edas y temas. Es un art\u00edculo interesante para iniciarse en el tema.<\/strong><\/p>\n A begginers guide to write documentation<\/a>: Sitio web con informaci\u00f3n, recursos, foro de documentalistas que sirve como punto de encuentro de documentalistas de software. Peri\u00f3dicamente organizan encuentros profesionales y conferencias.<\/p>\n Perfiles de twitter que hablan sobre documentaci\u00f3n:<\/p>\n @ericholscher <\/a><\/p>\n @troyhoward<\/a><\/p>\n @coderoshi<\/a><\/p>\n @writethedocs<\/a><\/p>\n \n \n Bibliograf\u00eda: <\/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. 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>. >. [Fecha de consulta: 30 de mayo de 2014]. <\/p>\n Why Free Software needs Free Documentation. https:\/\/www.gnu.org\/philosophy\/free-doc.en.html<\/a>. [Fecha de consulta: 1 de junio de 2014]. Documentaci\u00f3 de programes en programari lliure.<\/p>\n![\"chromium\"](\"http:\/\/multimedia.uoc.edu\/blogs\/documentacio\/files\/2014\/09\/chromium.png\")
<\/a><\/p>\n