Example Requirements Document - brianhigh/data-workshop GitHub Wiki

The following documents may be used to present the project requirements to a system analyst, designer, or developer.

• Example System Overview
• Example Goals List
• Example Structured Narrative
• Example Use Case Diagram
• Example Swim Lane Diagram
• Example Flow Chart
• Example Data Flow Diagram

The collection of these documents for a specific project is called the “requirements document”. This document should provide a clear, unambiguous, and precise specification of the system. However, as the documents are prepared, questions will naturally arise, details will emerge, and the workings of the system will become more clear. We will try to show a little of this evolution in the examples.

There are many other types of diagrams and documents which might be used to formally describe a system. The set of documents used should match the type and needs of the project. This list is relatively abbreviated compared to most software development projects. Instead, this list is just a minimal set of examples which might be suitable for a scientific research project using a database and statistical software to analyze research data. As such, there is no requirements document specifying a particular user interface. Instead, the generic user interface to the data collection tool, database product or statistical software would be used instead.