Skip to main content
Irrevo Best Practices

Creating functional design documents

The first step in the design phase of a content migration project is to align the requirements and research gathered into a series of functional design documents. Depending on the scope of your project, there could be separate documents for each screen or window in a knowledge management application, or it could be as simple as one document that covers the entire knowledge management process. Check out this CRM integration as an example.

Tools for functional design

The design phase should describe the process flow, define each data element and what they are used for, and include integration points to other applications. Mockups are extremely useful to help developers visualize the design and flow of how the screens and fields will be used. Process-flow diagrams help identify the sequence of the process and how to tie the functions together, plus they should spell out any dependencies on other processes or applications.

Describing the process for multiple audiences

The functional design documents, process-flow diagrams, and mockups should all paint a picture for not only the developers but also the business analysts, subject matter experts, and ultimately the end users that will be validating the design and using it on a daily basis. These will be the building blocks to several other deliverables generated during the design phase like the content standard, test plans and communication plans. Migration scripts may also need to be created if using an automated migration technique. These scripts will be dependent on content inventory maps and static setup data required by the tool application.