This template requires needs a format check.

1 [Project Title]

1.1 [Subtitle or short description]

1.2 [Authors]

1.3 [Team or organization that is writing this document]

1.4 Versions log

2 Table of contents

3 [application name] System

Related Documents Requirements are located [at the foobar wiki].

System Description Foobar makes a great travel companion.

Engineering Concerns Notes about reliability and security. Safety is a non-issue with the foobar because none of the user have a chance of foobaring themselves with anything sharp.

Likely Changes Hardware H1. hardware change H2. hardware change H3. etc

Software

Wetware

Unlikely Changes Assumptions

4 [application name] Module Guide

Goals of the Module Structure Design Principle

5 Subsystem1

Description of subsystem1 Behaviour Hiding Modules Module name Service Secret Associated Changes Module2 name Module3 name, etc Device Interface Modules Software Design Hiding Modules Potential Issues Subsystem Design Markup Illustration

6 Subsystem2

7 Subsystem3, etc

8 System Markup Illustration

9 Appendices

Module Hierarchy [some cool picture of the hierarchical structure of the foobar design with concern to available services, secrets, and associated changes, but not to a particular use case or implementation]

9.1 Glossary

System - Hardware, Software, Wetware, often affected or subjugated in that order, either ascending or descending. In some cases, the lines of the foobar blur and some parts do not seem so exclusive. Hardware - The solids, materials, rocks, or sticks. Software - The electromagnetism stuffs. Wetware - (2) People http://www.catb.org/jargon/html/W/wetware.html Design - With concern to modules that make the foobar. Architecture - With concern to the environment(s) where the foobar lives.

10 Acknowledgements

This design document, the Application System Module Guide Template, is based on the FWS design document by Professor David M. Weiss, with a format conforming more to APA.

11 License

© 2011 Alan Shea Anderson-Priddy Provided the License and Acknowledgements sections remain intact, though you may add addendums for documentation purposes, anyone may use this document, modify or redistribute it under the licenses either the GNU-FDL 1.3 (or later) or CC-BY 2.0 (or later), whichever pleases the user.