Task Number : 004
Task Name : SSS Documentation
Task Type : Development
Task Budget : $100
Time Frame : OPEN – due when completed
*** DRAFT ***
This is an initial DRAFT TASK SPECIFICATION.
The specification may change.
Develop written documentation to describe the functioning of the routines in the SSS Form_login.
Your documentation will become part of a technical training discipline so that new entrants – whether skilled or beginning programmers – can quickly understand how SSS works, and how [url removed, login to view] works.
Your documentation will assist beginning programmers understand the structure and function of these routines on a step-by-step basis.
Guoxin Liu and Mac Clark prepared the attached sample to show how the documentation looks and what it should contain.
This format of the documentation – as well as its content – is still under development. Your contributions will help create the format that we will use in all future documentation efforts.
Format So Far
The documentation format so far follows the basic Management Strategies Document Publication Guidelines. A separate specification provides you with the details of the Document Publication Guidelines. Please consult that Document Publication Guidelines for further details.
Organization of Content
Section 1 Introduction
Section 2 Program Overview & Instructions
Section 3 Design
Section 3.1 UI
Includes a snapshot of the form
Includes an itemization of form controls
Section 3.2 Background
Section 3.3 Routines
A itemization of all the routines in the module or class.
Section 3.4 Key variables
For example, GLOBALs that the software logic requires to perform properly.
---- TO BE COMPLETED ----