Typical software documents
This presentation is the property of its rightful owner.
Sponsored Links
1 / 22

Typical Software Documents PowerPoint PPT Presentation


  • 46 Views
  • Uploaded on
  • Presentation posted in: General

Typical Software Documents. with an emphasis on writing proposals. Technical Writing. Will you do much professional writing? What type of writing does a technical person create?. Tech Documents o' Plenty. Project Proposal Statement of Work Software Project Management Plan

Download Presentation

Typical Software Documents

An Image/Link below is provided (as is) to download presentation

Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author.While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server.


- - - - - - - - - - - - - - - - - - - - - - - - - - E N D - - - - - - - - - - - - - - - - - - - - - - - - - -

Presentation Transcript


Typical software documents

Typical Software Documents

with an emphasis on writing proposals


Technical writing

Technical Writing

Will you do much professional writing?

What type of writing does a technical person create?


Tech documents o plenty

Tech Documents o' Plenty

  • Project Proposal

  • Statement of Work

  • Software Project Management Plan

  • System Requirements Specification

  • System Design


Request for proposals

Request for Proposals

RFP = Request for Proposals

  • most government business is done this way

    • many companies exist solely to respond to government RFPs

  • some companies also solicit work via RFPs

    • eg addition to Thurmond Building


Nsf proposal format

NSF Proposal Format

Cover Sheet

title

dates and total amount requested

signatures

Project Summary

one page max

"intellectual merit" and "broader impact"

Table of Contents

Project Description

15 page max

also includes results from prior support

References Cited

Biographical Sketches

Budget


Possible format of a business proposal

Possible Format of a Business Proposal

  • Executive Summary

  • Statement of Work

  • Management Plan

  • Corporate Qualifications

  • Staffing Plan

  • Pricing and Contract Requirements


Good proposals

Good Proposals

  • Be clear!!!

    • Don't assume the reader will figure out the details.

    • State the obvious.

  • Be complete.

    • Know what the reader wants to know and provide that information.


The need to be clear

The Need to be Clear


Statement of work

Statement of Work

  • The usual written agreement before any work has started or any contract has been signed. Usually created by the software company. Always fairly short.

  • "A SOW should specify in clear, understandable terms the work to be done in developing or producing the goods to be delivered or services to be performed by a contractor.

  • A SOW defines (either directly or by reference to other documents) all non-specification requirements for contractor effort."


Sow format example

SOW Format – example

STATEMENT OF WORK

1. GENERAL. The Bureau of Reclamation has a requirement for …

2. BACKGROUND.

3. WORK TO BE PERFORMED BY CONTRACTOR.

4. GOVERNMENT-FURNISHED MATERIALS/SERVICES.

5. SUMMARY OF DELIVERABLE.

6. PROJECT COMPLETION/DELIVERY SCHEDULE

6.1 REVIEW OF DELIVERABLES.

6.2 ACCEPTANCE OF DELIVERABLES.

7. CONTRACTOR PAYMENT SCHEDULE

8. TECHNICAL COORDINATION

9. ADDRESS FOR DELIVERABLES


Software project management plan

Software Project Management Plan

  • Goal Statement

  • Process Model

    • management and technical

  • Organization

  • Timetable and Deliverables

    • sub-tasks

  • Budget


Ieee 1058 standard for spmp

1. Introduction

1.1 Project overview

1.2 Project deliverables

1.3 Evolution of the SPMP

1.4 Reference materials

1.5 Definitions and acronyms

2. Project organization

2.1 Process model

2.2 Organizational structure

2.3 Organizational boundaries and interfaces

2.4 Project responsibilities

3. Managerial process

3.1 Managerial objectives & priorities

3.2 Assumptions, dependencies & constraints

3.3 Risk management

3.4 Monitoring & controlling mechanisms

3.5 Staffing plan

4. Technical process

4.1 Methods, tools & techniques

4.2 Software documentation

4.3 Project support functions

5. Work packages, schedule & budget

5.1 Work packages

5.2 Dependencies

5.3 Resource requirements

5.4 Budget & resource allocation

5.5 Schedule

IEEE 1058 Standard for SPMP


System requirements specification

System Requirements Specification

  • Describes What to build, not How

    according to IEEE standard 830:

  • “The SRS must correctly define all of the software requirements, but no more.”

  • “The SRS should not describe design, verification, or project management details, except for required design constraints.”


System requirements specification1

System Requirements Specification


Characteristics of a good srs

Characteristics of a Good SRS

  • Unambiguous

  • Complete

  • Verifiable

  • Consistent

  • Modifiable

  • Traceable

  • Prioritized


Ambiguousness example one

Ambiguousness – example one

The control total is taken from the last record.

  • The total is taken from the record at the end of the file.

  • The total is taken from the latest record.

  • The total is taken from the previous record.

IEEE 830-1984


Ambiguousness example two

Ambiguousness – example two

All customers have the same control field.

  • All customers have the same value in their control field.

  • All control fields have the same format.

  • One control field is issued for all customers.

IEEE 830-1984


Srs table of contents

SRS Table of Contents

  • Introduction

    • Purpose

    • Scope

    • Definitions

    • References

    • Overview

  • General Description

    • Product Perspective

    • Product Functions

    • User Characteristics

    • General Constraints

    • Assumptions and Dependencies

  • Specific Requirements

IEEE 830-1984


Typical software documents

3. Specific Requirements

3.1 Functional Requirements

3.1.1 Func Req 1

3.1.1.1 Introduction

3.1.1.2 Inputs

3.1.1.3 Processing

3.1.1.4 Outputs

3.1.2 Func Req 2

3.2 External Interface Requirements

3.2.1 User Interface

3.2.2 Hardware Interfaces

3.2.3 Software Interfaces

3.2.4 Communication Interfaces

3.3 Performance Requirements

3.4 Design Constraints

3.4.1 Standards Compliance

3.4.2 Hardware Limitations

3.5 Attributes

3.5.1 Security

3.5.2 Maintainability

3.6 Other Requirements

3.6.1 Database

IEEE 830-1984


Typical software documents

SRS…


System design document

System Design Document

  • Data Dictionary

  • Entity Relationship Diagrams

  • Data Flow Diagrams

  • Control Flow Diagrams

  • Use Case Diagrams

  • State Transition Diagrams


Typical software documents

  • Proposal

    • we would like to do this for this amount

  • Statement of Work

    • we agree to do these things for this amount

  • Software Project Management Plan

    • who is doing what, when, and how

  • System Requirements Specification

    • what must this software do, contain, etc

  • Software Design

    • how is this software put together


  • Login