¿Cómo escribir Documentación de software?
Escribe una documentación de software para usuarios técnicos
Determina qué información debe estar incluida. Decide cuánto de la documentación debe estar dentro del código del programa y cuánto debe estar aparte. Elige la herramienta de documentación adecuada.
Los documentos de especificaciones de software sirven como manuales de consulta para los diseñadores de la interfaz de usuario, los programadores que escriben el código, y los ensayadores que verifican que el software funcione como es debido. La información exacta depende del programa en cuestión, pero puede incluir cualquiera de las siguientes cosas:  Archivos esenciales dentro de la aplicación. Esto puede incluir los archivos creados por el equipo de desarrolladores, las bases de datos a las que accede el programa en funcionamiento, y los programas utilitarios de terceros. Funciones y subrutinas. Esto incluye una explicación de lo que hace cada subrutina o función, incluyendo los alcances de sus valores de entrada y de salida. Las variables y constantes de programa, y cómo se utilizan en la aplicación. La estructura general del programa. Para una aplicación que funciona en el disco rígido, quizás sea necesario describir los módulos individuales y las librerías del programa, mientras que para una aplicación de internet, quizás sea necesario describir qué páginas utilizan cuáles archivos. Cuanto más desarrolles la documentación técnica dentro del código fuente del programa, más fácil será actualizarla y mantenerla a la par del código, y también será más fácil documentar las diversas versiones de la aplicación original. Como mínimo, la documentación dentro del código fuente debe explicar el propósito de las funciones, subrutinas, variables y constantes.  Si el código fuente es especialmente largo, puede ser documentado en forma de un archivo de ayuda, el cual puede estar indexado o puede permitir búsquedas a través de palabras claves. Esto es especialmente ventajoso para las aplicaciones en las que la lógica del programa se encuentra fragmentada a lo largo de varias páginas e incluye una cantidad de archivos complementarios, como sucede con ciertas aplicaciones de internet. Algunos lenguajes de programación, como Java y la infraestructura digital (framework) .NET (Visual Basic.NET, C #), tienen sus propias normas para documentar el código. En estos casos, sigue las normas acerca de cuánto de la documentación debe incluirse con el código fuente. Hasta cierto punto, esto está determinado por el lenguaje con el que esté escrito el código, ya sea C++, C# , Visual Basic, Java o PHP, ya que existen herramientas específicas para estos y otros lenguajes. En otros casos, la herramienta a utilizar se determina dependiendo del tipo de documentación que sea necesario.  Los procesadores de texto de Microsoft Word son adecuados para crear archivos de texto de la documentación por separado, siempre y cuando la documentación sea bastante corta y simple. Para archivos de texto largos y complejos, muchos escritores técnicos prefieren herramientas de documentación como Adobe FrameMaker. Se pueden crear archivos de ayuda para documentar el código fuente utilizando cualquier herramienta para crear archivos de ayuda, como RoboHelp, Help and Manual, Doc-To-Help, MadCap Flare, or HelpLogix.
Writing Software Documentation for Technical Users