SOFTWARE PROCESS DOCUMENTS
The list below represents a general set of documents for each identified phase of the software development process, from Project Plan to Delivery. This is meant only as a guide. You should consult your individual advisor for input. They may have a preferred set of documents, content or format criteria, or an alternative set of templates.

Project Plan(beyond Proposal)

  • Summary of Project
  • Summary of Methodology
  • Task breakdown and Cost Estimation
  • Risk Assessment
  • Legalities (intellectual property; classified;...)
  • Deliverables
  • Timeline
  • Quality Assessment (scope; significance; performance measures, performance goals,...)

    • Requirements Documents

      Requirements Analysis (User needs)
  • Interview notes
  • Environment
  • Stakeholder's needs
  • User desires / goals
  • Security Needs
      • Requirements Specification(for design team)
  • Use Case Scenarios
  • Features Set
  • Platform and Environment requirements
  • Other (non-functional) requirements

    • Design Document

  • UML modeling diagrams (class, state, transition, ...)
  • System Architecture
  • System Components
  • Interface to User or External Environment
  • Plan for System Deployment & Integration
  • Algorithmic choices
  • Storage/Persistence Issues
  • Security Mechanisms
  • Limitations of Design

    • Implementation & Testing

  • overall test plan
  • unit testing
  • test suites for features; use-cases; goals...
  • integration testing
  • test results & analysis
  • Appendices of Code, Data, Results,...

    • Delivery Documents

  • System manual (installation/configuration/...)
  • Release Notes
  • User manual
  • Demo Script
  • FAQ / Troubleshooting
  • Checklist / Status
  • Summary of Outcomes (relate back to project goals, performance measures, and criteria for success)
  • Future of project (plans to continue, recommendations, etc.)...


    • TEMPLATE SOURCES
    tigris (opensource) website
    tigris templates (local zip file)

    last update: 09/04/08