Software Manual

<Project Name>

<Authors>

<Date>

<Note: everything surrounded by <> is either a placeholder to be filled in or a comment to be deleted. All tables contain fictional example entries which should be removed.>

Documentation, Standards and Conventions

<Examples should be included in each secion.>

Internal Documentation

<Describes the format and content of the documentation internal to each module of the source code and where the documentation is located relative to the module itself.>

Coding Standards

<Describes what standards are used in formatting the source code.  Example include rules for indentation and blank lines, variable naming conventions, formats for declarations and formal parameters, and examples of how different types of statements are formatted.>

File Naming Conventions

<Describes how each file is to be named that contains part of the source code, and each additional file placed on the software page>

Source Code Files

<Each filename should have an <ID> to allow cross-referencing to the appropriate test plan.

The list should include only those files generated by you.>

<ID> SourceCodeFileName.Extension

Purpose:  <short description of what this software file is supposed to do within the larger context of the entire software>

Software Installation

<ID> Development Platform

• Hardware
  • <hardware requirements - one item per bullet>
• Software
  • <software requirements - one item per bullet>
• Installation and Configuration Instructions for the Client's Software
  • <Description of how to install and configure the client's software on the development platform so that other developers or maintainers can work on it if necessary.>

<ID> Client Delivery Platform

• Hardware
  • <hardware requirements - one item per bullet>
• Software
  • <software requirements - one item per bullet>
• Installation and Configuration Instructions for the Client's Software
  • <Description of how to install and configure the client's software on the delivery platform so that the client can use it.>

Revision History

Date	Who	Revision
2/2/2003	Groucho	Wrote software installation section