Table of Contents
Design and Specification Template
Please use this template when creating new specifications on the Mayon project.
Design and Functional Requirements
| Reference Information | |
|---|---|
| Name of Design & Functional Preparer: | Name |
| Name of Other Contributors: | Names |
| Last Updated: | Date |
Note on contribution: Please feel free to fill out sections of the specification as this project is a collaborative effort; however, if you feel your ideas could be in conflict to previous ideas or you want to change sections already fleshed out please use the discuss tab first and find consensus with others working on this module or section.
Overview
<Fill out an overview of the functionality of the module or idea>
Use Case
<Elaborate on how someone would use the module or functionality>
Non-Goals
<What shouldn't this piece do?>
Open Issues
<Recognized problems, holes in the design, and known issues>
Workflow
<What screens should the user see? How should the work flow through the module? Good to include some sketches or pictures.>
Technical Specifications
| Reference Information | |
|---|---|
| Name of Design & Functional Preparer: | Name |
| Name of Other Contributors: | Names |
| Last Updated: | date |
The technical specifications are drawn directly from and written to satisfy user stories and workflow documents, they are the codex between user logic and computer logic. Computer logic is broken up to differentiate between front-end and back-end. Front-end and Back-end both correspond to workflow diagrams and user stories.
Unit of Work 1 for Spec
Technical Overview:
Some top level technical information on achieving this goal
| user | frontend | backend |
|---|---|---|
| “nugget of information from user story 1” | ui element construction | query description, actions needed |
| link to image or part of image of workflow piece | ui element code | schema changes? |
Unit of Work 2 for Spec
Technical Overview:
Some top level technical information on achieving this goal
| user | frontend | backend |
|---|---|---|
| “nugget of information from user story 2” | ui element construction | query description, actions needed |
| link to image or part of image of workflow piece | ui element code | schema changes? |
Note on contribution: Please feel free to fill out sections of the specification as this project is a collaborative effort; however, if you feel your ideas could be in conflict to previous ideas or you want to change sections already fleshed out please use the discuss tab first and find consensus with others working on this module or section.
