Documentation système
La documentation système comprend une vue d’ensemble du système. Cette documentation doit permettre à quiconque de comprendre toutes les considérations prises en compte lors de la création du système. La documentation système comprend le plus souvent les besoins, la conception architecturale, le code source, les témoignages utilisateur et les informations de test.
Dans la partie du document dédiée aux besoins, vous devez inclure toutes les personnes impliquées dans le projet :
- Membres de l’équipe du client
- Membres de l’équipe de projet
- Parties prenantes
- Responsable du système chez le client
La documentation doit décrire pourquoi vous créez le système, les objectifs du projet et comment le système est en phase avec les objectifs d’entreprise du client.
Ajoutez tout type de considérations que vous et votre client avez, qu’il s’agisse de réglementations régionales ou sectorielles ou de considérations techniques. Ces considérations sont importantes, car elles clarifient les raisons pour lesquelles vous avez choisi de créer la solution comme vous l’avez fait.
Les personnages utilisateur et les scénarios utilisateur doivent être intégrés à la documentation système. Ces personnages et scénarios décrivent pour qui vous créez le système et les scénarios que le système doit permettre de prendre en charge.
Ensuite, ajoutez les témoignages utilisateur et les critères d’acceptation de tous vos témoignages utilisateur. N’oubliez pas que vous devez créer votre solution sur la base de ces témoignages utilisateur. Ne créez jamais une partie de la solution que vous ne pouvez pas mapper à un témoignage utilisateur. Les critères d’acceptation vous indiquent quand un témoignage utilisateur est accepté et quand vous avez terminé votre tâche.
Il est toujours avantageux d’inclure un schéma de l’architecture de la solution. Le schéma doit comprendre l’aspect technique de votre solution et où la solution est placée dans le paysage technique de la société.
Dans de nombreuses solutions Microsoft Dynamics 365, les développeurs de code seront impliqués et ils auront écrit du code personnalisé. La documentation système doit toujours contenir des informations sur toutes les parties de votre système développées par code.
Si vous avez configuré un plan de test, veillez à l’intégrer à votre documentation système. Ensuite, vous pouvez montrer tout ce que vous avez testé, qui a effectué les tests et les résultats.