Table of Contents
Design Document
Core Engine
Describe each of the characteristics about the engine:
- Easy of Use
- Cross-Platform Compatibility
- Look-and-Feel
- Support
- Extensibility
Communications
What data needs to be transmitted between the client and server. Try to keep this as small as possible.
Threading
How one would create threads within the Core Engine.
Settings
The configuration data used to initialize the Core Engine.
Server
Describe what the server will store and process.
Client
Describe what the client will store and process.
User Interface
Describe what the interface will look like. Possibly, provide a mock up.
Core Status
What kind of information are we monitoring. How will we display it to the user.
Module Management
How will a user manage the modules.
Modules
A list of modules to be created with a description on how they work. Each module will need to describe a management side and a client side.
System Status
System Command Line
Remote Desktop
Torrents
External Elements
Most of these elements will have their own design documents.
- Web Sites
- Forums
- Updates
- Tech Support
- Distribution