next up previous contents
Next: 3. Testing 1 2 Up: I. Tapio RFCs Previous: 1. Plumbing Protocol   Contents

Subsections

2. Stream Format

2.1 Executive Summary

This is a brief description of why we need the widget and what it will do.

2.2 Introduction

Explanation of the problem set and what we intend to accomplish

2.3 References

References to any other documents of interest to us.

2.4 Definitions

Define here all the terms needed.

2.5 Requirements

Lay out the functional requirements of the widget.

2.6 Assumptions

The environment in which the widget runs. We assume certain things about it. Tell us.

2.7 Relationships

Define how this interacts with other components in the system.

2.8 User Interface

How to invoke it.

2.9 Interfaces/Protocols

Structure of any data going in/out of it.

2.10 Procedure/Transaction Definitions

If there are specific operations that can be performed, describe them here.

2.11 Data/System Integrity Considerations

How do we keep from corrupting data or databases?

2.12 Reliability and availability issues

Specify how we address reliability.

2.13 Security and Privacy issues

Specify how we address security and privacy issues.

2.14 Safety Issues

If the software could cause safety issues (e.g., could make a robot arm tatoo the Ford logo on a lineman's rear), address those here.

2.15 Quality Assurance

How we will make it work right.

2.16 Performance Issues

How we will make it work fast.

2.17 Implementation Methods

Any other stuff related to implementation that we need to mention

2.18 Risks

What could make this part of project fall behind schedule.


next up previous contents
Next: 3. Testing 1 2 Up: I. Tapio RFCs Previous: 1. Plumbing Protocol   Contents
The Unknown Hacker 2001-07-06