System documentation
System documentation includes a complete overview of the system. This document should help anyone understand all considerations that were taken during system creation. The system documentation will most often include the requirements, architectural design, source code, user stories, and test information.
In the requirements part of the document, you should include everyone who’s involved in the project:
- The customer’s team members
- Project team members
- Stakeholders
- Who, at the customer, owns the system
The documentation should describe why you’re building the system, the goals for the project, and how the system will align with the customer’s company goals.
Add any type of considerations that you and your customer have, whether regional or industry-specific regulations or technical considerations. These considerations are important because they clarify the reasons why you’ve chosen to create the solution the way that you have.
User personas and user scenarios should be included in the system documentation. These personas and scenarios describe who you’re creating the system for and what scenarios the system should help solve.
Next, add the user stories and acceptance criteria of all your user stories. Remember, you should build your solution based on these user stories. Never create any part of the solution that you can’t map to a user story. The acceptance criteria tells you when a user story is accepted and when you’ve completed your task.
It's always beneficial to include a solution architecture diagram. The diagram should include the technical aspect of your solution and where the solution is placed in the company's technical landscape.
In many Microsoft Dynamics 365 solutions, code developers will be involved, and they’ll have written custom code. The system documentation should always have information about all parts in your system that are developed by code.
If you’ve set up a test plan, make sure that you include it in your system documentation. Then, you can show everything that you’ve tested for, who’s done the testing, and the results.