No todo ha escrito documentación de software, pero todo el mundo ha leído la documentación de software que dejó mucho que desear . Cuando estamos buscando para encontrar información sobre una pieza de software , queremos saber lo que hace, lo que los sistemas operativos y otros programas que trabaja, cómo podemos hacerlo , y cuánto cuesta. Cosas que necesitará
Una pieza de software
Ver Más instrucciones
diferentes tipos de software de documentación
1
Escribe lo que hace el software. Después de leer este documento , el lector debe ser capaz de determinar si se necesita el software . Asegúrese de incluir todas las capacidades , que muchas veces puede ser una lista de todas las funcionalidades del software .
2
Explique cómo funciona el software en relación con otras piezas de software. Esto se puede hablar de otras piezas de software que se consideran competitors.Be Asegúrese de describir lo que esta pieza de software que hace diferente a los demás.
3
delinear los tipos de interfaces y el código que se utilizan en el software . En esta sección se debe dejar al lector saber qué tipo de conocimiento debe tener un usuario para trabajar con este software . Esta parte de la documentación del software es utilizado por los programadores y otras personas técnicas.
4
Hacer un documento para el usuario del software para que cualquiera que lo lea podrá comenzar a utilizar el programa. Estos tipos de documentación pueden ser tutoriales. También puede ser una lista de comandos o índices de donde los usuarios pueden encontrar la información relevante.
5 documentación Escribir
que los vendedores pueden utilizar cuando están vendiendo la software.Make seguro que has incluido toda la capacidades y puntos de venta de software.