Technical Specifications - Collaborative Design - Slides | CSE 498, Study notes of Computer Science

Material Type: Notes; Professor: Dyksen; Class: Collaborative Design (W); Subject: Computer Science & Engineering; University: Michigan State University; Term: Fall 2008;

Typology: Study notes

Pre 2010

Uploaded on 07/28/2009

koofers-user-uby
koofers-user-uby šŸ‡ŗšŸ‡ø

10 documents

1 / 7

Toggle sidebar

This page cannot be seen from the preview

Don't miss anything!

bg1
CSE 498, Collaborative Design 2. Technical Specifications
Dr. Wayne Dyksen 2-1 Michigan State University
2. Technical Specifications
Dr. Wayne Dyksen
Department of Computer Science and Engineering
Michigan State University
Fall 2008
CSE 498, Collaborative Design
2-2
Technical Specification
•Written Document
•Describes
– The ―Problem‖
–Your Proposed Solution
•Complete
–Functionally
–Design-Wise
–Technically
• ―Only‖ Thing Left To Do Is ―Programming‖
•(Ideally) Could Be Used for Out-Sourcing
•(AKA, Architecture Document,...)
2-3
Design Process Overview
2. Design
Specifications
3. Technical
Specifications
1. Functional
Specifications
2-4
Technical Specifications
ļƒ–Functional Specifications
Design Specifications
Technical Specifications
2-5
Functional Specifications
• What it’s supposed to do?
(Not ―how‖ is it supposed to do it?)
•Short List of Features
•Not Necessarily Complete
•Starting With
–Shared Vision?
–No Formal Documents?
–Minimal Documents?
–Incomplete Problem Statement?
•Understandable by End User
•Initial Problem Statement
•Usually Refined
2-6
Building a House (1 of 4)
Functional Specifications
•4 Bedrooms
•2.5 Bathrooms
•Study
•2-Car Garage
•Walk-Out Basement
(Note: Understandable by ―User‖)
Functionally, what else might
you like to know?
pf3
pf4
pf5

Partial preview of the text

Download Technical Specifications - Collaborative Design - Slides | CSE 498 and more Study notes Computer Science in PDF only on Docsity!

2. Technical Specifications

Dr. Wayne Dyksen Department of Computer Science and Engineering Michigan State University Fall 2008 CSE 498, Collaborative Design 2 - 2

Technical Specification

  • Written Document
  • Describes
    • The ―Problem‖
    • Your Proposed Solution
  • Complete
    • Functionally
    • Design-Wise
    • Technically
  • ―Only‖ Thing Left To Do Is ―Programming‖
  • (Ideally) Could Be Used for Out-Sourcing
  • (AKA, Architecture Document,...) 2 - 3

Design Process Overview

  1. Design Specifications
  2. Technical Specifications
  3. Functional Specifications 2 - 4

Technical Specifications

ļƒ–Functional Specifications Design Specifications Technical Specifications 2 - 5

Functional Specifications

  • What it’s supposed to do? (Not ―how‖ is it supposed to do it?)
  • Short List of Features
  • Not Necessarily Complete
  • Starting With
    • Shared Vision?
    • No Formal Documents?
    • Minimal Documents?
    • Incomplete Problem Statement?
  • Understandable by End User
  • Initial Problem Statement
  • Usually Refined (^2) - 6

Building a House (1 of 4)

Functional Specifications

  • 4 Bedrooms
  • 2.5 Bathrooms
  • Study
  • 2 - Car Garage
  • Walk-Out Basement (Note: Understandable by ―User‖) Functionally, what else might you like to know?

2 - 7

Building a House (2 of 4)

Functional Specifications Refined

  • ~ 2,500 sq. ft.
  • $275,000 - $325,
  • 4 Bedrooms
  • 2.5 Bathrooms
  • Formal Living Room and Family Room
  • Study
  • 2 - Car Garage
  • Walk-Out Basement What do you need to know next? 2 - 8

Interactions With Your Client

Functional Specifications

  • Derived With/From Client
  • Documented For Client
  • Presented to Client
  • Agreed Upon With Client
  • Your Job to Capture the Client’s Intent! 2 - 9

Technical Specifications

Functional Specifications ļƒ–Design Specifications Technical Specifications 2 - 10

Design Specification

  • Written Document
  • Includes
    • ―Business‖ Process Flow
    • Use Cases
    • Screen Mockups
    • Data Flow Diagrams
    • Data Organization
    • Etc…
  • Identifies All the Parts and Their Interactions
  • (Mostly) Understandable by End User
  • Usually Refined 2 - 11

Building a House (3 of 4)

Design Specifications

  • Mission Style, Stone Front
  • Lots of Light
  • Kitchen Connected to Family Room
  • Master Bedroom on Main Floor
  • Cathedral Ceilings
  • Granite Counter Tops
  • Etc… (Note: Understandable by ―User‖) What else will you need to know to build the house? 2 - 12

Screen Mock-Ups

  • User Interface Only
    • Shows Layout, Buttons, Pull-Downs, Etc…
    • Non-Functional
    • No Back End
  • Helpful for Developing
    • Look-and-Feel
    • Use Cases
  • Can Create with…
    • Pencil and Paper
    • PowerPoint (Developer View)
    • Etc…

2 - 19

Technical Specification (2 of 2)

  • Includes Things Like…
    • Database Schema
    • Object Models and Class Diagrams
    • UML Diagrams
    • Pseudo Code
    • Function Prototypes
    • Schedule
    • Test Plan
    • Risk Analysis
    • Etc…
  • Probably Not Understandable by End User
  • Possibly Not Understandable by Client
  • Usually Refined 2 - 20

Building a House (4 of 4)

Technical Specifications

  • 20 lb Asphalt Roof Shingles
  • 2‖ x 6‖ Outside Walls
  • R48 Blown Attic Insulation
  • Cat5E Wiring
  • Pre-Made Roof Trusses
  • 12‖ Poured Concrete Foundation
  • Etc... (Note: Probably Not Understandable by ―User‖) 2 - 21

Approach

  • Break Big Problems Into Smaller Problems
  • Identify Constraints
  • Identify ―Risks‖—Things You Don’t
    • Know
    • Understand
    • Know How To Do
  • Consider Tradeoffs
  • Select Appropriate Technologies
  • Identify Core Features for a Prototype 2 - 22

Interactions With Your Client

Technical Specifications

  • Derived With/From Client
  • Documented For Client
  • Presented to Client
  • Agreed Upon With Client
  • Your Job to Capture the Client’s Intent! Cannot be emphasized enough! 2 - 23

How To’s (1 of 4)

  • Quickly identify…
    • what you don’t know,
    • what you don’t understand, and
    • what you don’t know how to do.
  • Conceptually…
    • Start with functional spec.
      • Get agreement with client.
      • Include as first part of technical spec.
    • Do design spec.
      • Get agreement with client.
      • Include as 2nd^ part of technical spec.
    • Do technical spec.
      • Get agreement with client.
      • Finish technical spec.
    • Do schedule.
    • Do development, testing, and deployment.
  • In CSE498, must do all three in parallel (and iterate). 2 - 24

How To’s (2 of 4)

  • Approach
    • Make Skeleton Document Immediately
      • Will Get You Organized and Focused
      • Include ―Under Construction‖ Sections (Totally Empty)
    • Develop In Parallel When Possible But…
      • Complete Functional First
      • Complete Design Second
      • Revise As Needed
    • Refine As Needed
    • Assign Sections to Team Members
    • Share with Client
      • Ask For (Specific) Feedback
      • Highlight What’s New
      • Tricky Balance
        • Not Enough?
        • Too Much? Is this what you had in mind?

2 - 25

How To’s (3 of 4)

  • Schedule
    • Dictated by Course
    • See Meeting Agendas
      • 09/08 Team Status Report
      • 09/15 Technical Specifications / Schedule
      • 10/06 Alpha Demos
      • 11/03 Beta Demos
      • 12/01 Project Video
      • 12/03 All Deliverables
    • Other Milestone By Educated Guesses
    • Track To It At Least Weekly at Triage Meetings
    • Revisit Often and Revise If Necessary
    • Delivery Slippage = Graduation Slippage (^2) - 26

How To’s (4 of 4)

―Living Document‖ Make Sure Your Tech Spec Has…

  • Cover Page
  • Title
  • Table of Content
  • Page Numbers
  • Headers and Footers
  • Etc… (That is, make sure your spec looks professional.) 2 - 27

Interactions With Client

Client May Specify…

  • Requirements
    • Functional
    • Design
    • Technical Requirements
      • Operating Systems
      • Programming Languages and Environments
      • Web Technologies
      • Etc…
    • Legacy
  • Milestones
  • Etc… (You may explore and propose other ideas.) 2 - 28

Nota Bene: Tech Spec

  • How many…
    • …drafts will you write? Many.
    • …drafts will you share with your client? A Couple.
    • …final documents will you submit for CSE498? One
  • Due Date
    • September 15
    • Less Than 4 Weeks
  • In Class Formal Presentations
    • September 15 – September 22
    • PowerPoint Template Provided 2 - 29

Resources on the Web (1 of 2)

  • By Peter Surna
    • How to Write Specifications Part 1
    • How to Write Specifications Part 2
    • Joke-A-Day Web Site – A Sample Design Specification
  • CSE498 Web Site Downloads
    • Motorola
    • Union Pacific

Resources on the Web (2 of 2)

  • W3 Schools
    • Web Developer Resources
      • Tutorials
        • HTML - .NET
        • XML - Multimedia
        • Browser Scripting - Web Building
        • Server Scripting
      • References
      • Examples
      • Quizzes
      • Quick Starters
    • Good
    • Free
  • CSE498 Web Site Resources 2 - 30

0 - 37

Team <#> Status Report (4 of 4)

  • Risks
    • Risk 1
      • Description
      • Mitigation
    • Risk 2
      • Description
      • Mitigation
    • Risk 3
      • Description
      • Mitigation
    • Risk 4
      • Description Team <#>: <team_name>^ •^ Mitigation