Tipos de documentación de software

Tabla de contenido:

Anonim

Si alguna vez ha visto un directorio de computadora en una unidad de red en su compañía llamada "documentos de software" o "guías de software" y luego miró los documentos que tenía permiso para ver, probablemente se dio cuenta de la cantidad de documentos y tipos de documentos para software. numeroso. También parece que algunos documentos colocados en una categoría se aplican también a otras categorías. Los documentos de software se utilizan en cada etapa de un ciclo de vida típico del software, por lo que es un buen lugar para investigar el tipo de documentos creados.

Propuesta

Una propuesta de software especifica los requisitos del sistema de software y delinea el propósito del software y los problemas que resuelve. También especificará el tiempo estimado que tomará el proyecto de software y otros factores que afectan la propuesta.

Estudio de factibilidad

El estudio de factibilidad usualmente se lleva a cabo al inicio del proyecto. Esta etapa determina si la planta de software satisface las necesidades comerciales del cliente. El resultado de un estudio de viabilidad decide si un proyecto seguirá adelante o no.

Análisis de requerimientos

Un análisis de requisitos proporciona los medios para traducir los requisitos comerciales en soluciones de software automatizadas. Un consultor externo o la gerencia de la compañía generalmente realiza esta tarea. Los requisitos convierten los requisitos empresariales en especificaciones reales para hardware, software y componentes.

Documentos de diseño

Los documentos de diseño proporcionan la base para que el desarrollo de software comience a nivel técnico. Como su nombre lo indica, se diseñarán varios diseños gráficos y textuales para bases de datos, interfaces, comunicaciones, desarrollos web y otros aspectos del software antes de que pueda comenzar la codificación.

Documentos de codificación

Los documentos de codificación se refieren al código fuente real utilizado para la programación del software. El código puede estar escrito en cualquier número de lenguajes informáticos disponibles, incluidos Java, C ++, PHP y cientos de otros lenguajes informáticos, según el sistema utilizado.

Documentos de prueba

Los equipos de prueba y los desarrolladores crean documentos de prueba en diversas etapas del ciclo de vida del software. Los desarrolladores crean documentos de prueba de unidad para su propio código. El equipo de pruebas u otras personas que no están directamente asociadas con el código realizan pruebas de integración y pruebas de requisitos comerciales.

Guías de usuario y marketing

Las guías del usuario proporcionan instrucciones sobre cómo funciona el nuevo software. Si el sistema es grande y complejo, las guías del usuario generalmente están respaldadas por cursos formales de capacitación para el personal. Los documentos de marketing ilustran los beneficios del nuevo sistema de software para los clientes potenciales.

Licencias de software

La emisión de licencias de software hace que el uso del software sea legal en lo que respecta al usuario final. Los usuarios utilizan el software bajo los términos de una licencia de software emitida por la empresa de creación. No todo el software tiene términos de licencia estrictos, y esto es particularmente cierto en el caso del código abierto. Generalmente, los sistemas de software tienen algún tipo de documento de licencia en el lugar que especifica cómo y dónde se puede usar el software.