Documentación del sistema
En la documentación del sistema se incluye una visión general completa del sistema. Este documento le servirá de ayuda a toda persona que desee conocer todo lo que se ha tenido en cuenta durante la creación del sistema. La documentación del sistema incluirá en la mayoría de los casos los requisitos, el diseño de la arquitectura, el código fuente, las historias de usuario y la información de prueba.
En la parte de requisitos del documento, debe incluir a todas las personas involucradas en el proyecto:
- Miembros del equipo del cliente
- Miembros del equipo del proyecto
- Partes interesadas
- Quién, dentro del equipo del cliente, es propietario del sistema
En la documentación se debe describir por qué se está creando el sistema, los objetivos del proyecto y cómo se adaptará el sistema a los objetivos de la empresa del cliente.
Agregue todo elemento que usted y su cliente tengan en cuenta, ya sean normativas regionales o específicas del sector o consideraciones técnicas. Estas consideraciones son importantes, ya que aclaran los motivos por los que ha decidido crear la solución de la forma que lo ha hecho.
En la documentación del sistema deben incluirse los usuarios y los escenarios de usuario. Estas personas y escenarios describen para quién está creando el sistema y qué escenarios debería ayudar a resolver el sistema.
A continuación, agregue las historias de usuario y los criterios de aceptación de todas sus historias de usuario. Recuerde que debe crear la solución en función de estas historias de usuario. No cree nunca ninguna parte de la solución que no pueda asignar a una historia de usuario. Los criterios de aceptación le indican cuándo se ha aceptado una historia de usuario y cuándo ha finalizado su tarea.
Siempre es aconsejable incluir un diagrama de la arquitectura de la solución. El diagrama debe incluir los aspectos técnicos de la solución y dónde se ubica la solución dentro el panorama técnico de la empresa.
En muchas soluciones de Microsoft Dynamics 365, los desarrolladores de código estarán involucrados en el proceso y habrán escrito un código personalizado. La documentación del sistema siempre debe incluir información sobre todas las partes de su sistema que se han desarrollado con código.
Si ha configurado un plan de prueba, asegúrese de incluirlo en la documentación del sistema. A continuación, puede mostrar todo lo que ha probado, quién ha realizado la prueba y los resultados obtenidos.