SlideShare une entreprise Scribd logo
1  sur  10
Design Documentation


 Software Development



                        1
Software Development Lifecycle
This is used by software designers - the whole
design process can be thought of as a cycle
The stages are:
   Identify - Define requirements and specification
   Design - Plan the solution to the problem
   Develop - Produce the program code
   Test     - Locate and remove any errors
   Evaluate - Review against program requirements


                                                      2
Identify the Scope
The first stage of the design process is based upon
analysing the user’s requirements to determine
what is achievable with the resources available.
Resource limitations (called constraints) usually
involve time and money.
Prioritise the most important features and decide
what will be included in the first version of the
software and what can be left out and put on the
‘wish list’ for future versions.
You then need to produce a formal written
requirements specification for the program
                                                      3
Design Documentation
Requirement Specification:
  Inputs are required from the user
  Outputs expected by the user
  Processing needed to provide functionality
  Constraints e.g. time, funds, specialist skills
Screen Designs
Program Design: Modules and Algorithms:
  Structure Diagram / Flowcharts / Pseudocode
Data Dictionary
Test Plan
                                                    4
Requirements Specification
Inputs: List of all the data that is input by the user
   Give specific details of the actual data, e.g. first name
   and last name of user
   Identify valid and invalid values for text and acceptable
   ranges for numeric data
Outputs: List of all output expected by the user
   Give specific details of the actual data and format, e.g.
   Monthly sales report which will be displayed in a bar
   chart, showing total sales for each product
   Include any help information e.g. Instructions, error
   messages or visual feedback

                                                               5
Requirements Specification
Processing: Give details of all the functions the
program will need to have.
  You should break this down into each processing task
  e.g. validation, calculations, formatting etc.
  Explain what each function should do (not how – yet!)
  There could be many of these in your proposed system
Constraints: Identify any resource limitations
  It could include budget, development
  timescales, hardware available, training
  requirements, special needs of users etc.
  Give specific details of each, e.g. The total budget
  available is £50,000
                                                          6
Screen Designs
Provide a storyboard to show screens at
various stages of the program
Draw them…                      Count Down

  On paper…
  In Word or Visio…
  In Visual Studio…
They must show
  The prompts the user will see
  Example input
  Example output
                                             7
Process Specification

Requirements Specification - describes WHAT the
system must be able to do.
Process Specification - provides details of HOW the
required functionality is achieved.
Various techniques used to clarify procedures
  Flow Charts
  Structure Diagram
  Pseudocode / Structured English
Provides the logical design for a computer algorithm
Not language specific
                                                       8
Data Dictionary

This is used to document the variables and data
types used in your program
Show the variable names, datatypes and a
description of what data the variable is going to
store
Identify location e.g. Local or Global
  Remember local is better



                                             9
                                                    9
A Data Dictionary
      Table with details of all important variables

Variable                  DataType           Description

VAT            Global     Single, Constant   Holds current VAT
                                             rate (17.5%)
sngVATPrice    Local to   Single             Holds price of goods
               Checkout                      inc VAT
intQuantity    Local to   Integer            Number of items
               Checkout




                                                                    10

Contenu connexe

Tendances

Low level design template (1)
Low level design template (1)Low level design template (1)
Low level design template (1)anosha jamshed
 
Software Architecture and Design - An Overview
Software Architecture and Design - An OverviewSoftware Architecture and Design - An Overview
Software Architecture and Design - An OverviewOliver Stadie
 
Basic concepts and terminology for the Requirements Management application
Basic concepts and terminology for the Requirements Management applicationBasic concepts and terminology for the Requirements Management application
Basic concepts and terminology for the Requirements Management applicationIBM Rational software
 
Sterling Integrator Map Editor
Sterling Integrator Map EditorSterling Integrator Map Editor
Sterling Integrator Map EditorJeyhind M
 
Experiences and requirements for a User Interaction Modeling Language
Experiences and requirements for a User Interaction Modeling LanguageExperiences and requirements for a User Interaction Modeling Language
Experiences and requirements for a User Interaction Modeling LanguageMarco Brambilla
 
1000 solved questions
1000 solved questions1000 solved questions
1000 solved questionsKranthi Kumar
 
Visual basic
Visual basicVisual basic
Visual basicDharmik
 
Introduction to visual basic 6 (1)
Introduction to visual basic 6 (1)Introduction to visual basic 6 (1)
Introduction to visual basic 6 (1)Mark Vincent Cantero
 
Interaction Flow Modeling Language (IFML) First Submission at OMG
Interaction Flow Modeling Language (IFML)  First Submission at OMG Interaction Flow Modeling Language (IFML)  First Submission at OMG
Interaction Flow Modeling Language (IFML) First Submission at OMG Marco Brambilla
 
Presentation on visual basic 6 (vb6)
Presentation on visual basic 6 (vb6)Presentation on visual basic 6 (vb6)
Presentation on visual basic 6 (vb6)pbarasia
 
Programming Interface & SAP BDC
Programming Interface & SAP BDCProgramming Interface & SAP BDC
Programming Interface & SAP BDCSyam Sasi
 
Interaction Flow Modeling Language: updates on the Beta2 version - by the OMG...
Interaction Flow Modeling Language: updates on the Beta2 version - by the OMG...Interaction Flow Modeling Language: updates on the Beta2 version - by the OMG...
Interaction Flow Modeling Language: updates on the Beta2 version - by the OMG...Marco Brambilla
 

Tendances (20)

Low level design template (1)
Low level design template (1)Low level design template (1)
Low level design template (1)
 
Software Architecture and Design - An Overview
Software Architecture and Design - An OverviewSoftware Architecture and Design - An Overview
Software Architecture and Design - An Overview
 
Basic concepts and terminology for the Requirements Management application
Basic concepts and terminology for the Requirements Management applicationBasic concepts and terminology for the Requirements Management application
Basic concepts and terminology for the Requirements Management application
 
Resume (1)
Resume (1)Resume (1)
Resume (1)
 
Using idoc method in lsmw
Using idoc method in lsmwUsing idoc method in lsmw
Using idoc method in lsmw
 
Sterling Integrator Map Editor
Sterling Integrator Map EditorSterling Integrator Map Editor
Sterling Integrator Map Editor
 
Experiences and requirements for a User Interaction Modeling Language
Experiences and requirements for a User Interaction Modeling LanguageExperiences and requirements for a User Interaction Modeling Language
Experiences and requirements for a User Interaction Modeling Language
 
Reports 6i
Reports 6iReports 6i
Reports 6i
 
1000 solved questions
1000 solved questions1000 solved questions
1000 solved questions
 
Visual basic
Visual basicVisual basic
Visual basic
 
Programing techniques
Programing techniquesPrograming techniques
Programing techniques
 
Abap Questions
Abap QuestionsAbap Questions
Abap Questions
 
Chapter 6 Flowchart
Chapter 6   FlowchartChapter 6   Flowchart
Chapter 6 Flowchart
 
Sda 9
Sda   9Sda   9
Sda 9
 
Introduction to visual basic 6 (1)
Introduction to visual basic 6 (1)Introduction to visual basic 6 (1)
Introduction to visual basic 6 (1)
 
Interaction Flow Modeling Language (IFML) First Submission at OMG
Interaction Flow Modeling Language (IFML)  First Submission at OMG Interaction Flow Modeling Language (IFML)  First Submission at OMG
Interaction Flow Modeling Language (IFML) First Submission at OMG
 
Presentation on visual basic 6 (vb6)
Presentation on visual basic 6 (vb6)Presentation on visual basic 6 (vb6)
Presentation on visual basic 6 (vb6)
 
Programming Interface & SAP BDC
Programming Interface & SAP BDCProgramming Interface & SAP BDC
Programming Interface & SAP BDC
 
Builder pattern
Builder patternBuilder pattern
Builder pattern
 
Interaction Flow Modeling Language: updates on the Beta2 version - by the OMG...
Interaction Flow Modeling Language: updates on the Beta2 version - by the OMG...Interaction Flow Modeling Language: updates on the Beta2 version - by the OMG...
Interaction Flow Modeling Language: updates on the Beta2 version - by the OMG...
 

En vedette

En vedette (20)

Design Documentation
Design DocumentationDesign Documentation
Design Documentation
 
Design And Documentation
Design And DocumentationDesign And Documentation
Design And Documentation
 
Stage Lighting Technology and the Design Process
Stage Lighting Technology and the Design ProcessStage Lighting Technology and the Design Process
Stage Lighting Technology and the Design Process
 
Decisions
DecisionsDecisions
Decisions
 
Simple debugging
Simple debuggingSimple debugging
Simple debugging
 
Data types vbnet
Data types vbnetData types vbnet
Data types vbnet
 
Design for edp
Design for edpDesign for edp
Design for edp
 
Software development lifecycle
Software development lifecycleSoftware development lifecycle
Software development lifecycle
 
Ch 3 event driven programming
Ch 3 event driven programmingCh 3 event driven programming
Ch 3 event driven programming
 
Data structures vb
Data structures vbData structures vb
Data structures vb
 
Ndu06 typesof language
Ndu06 typesof languageNdu06 typesof language
Ndu06 typesof language
 
Decisions
DecisionsDecisions
Decisions
 
Simple debugging
Simple debuggingSimple debugging
Simple debugging
 
Event driven theory
Event driven theoryEvent driven theory
Event driven theory
 
Data types vbnet
Data types vbnetData types vbnet
Data types vbnet
 
Algorithms
AlgorithmsAlgorithms
Algorithms
 
Event driven programming amazeballs
Event driven programming amazeballsEvent driven programming amazeballs
Event driven programming amazeballs
 
Controls
ControlsControls
Controls
 
Event oriented programming
Event oriented programmingEvent oriented programming
Event oriented programming
 
Using loops
Using loopsUsing loops
Using loops
 

Similaire à Software Design Documentation

03 analysis of_requirementsspecification
03 analysis of_requirementsspecification03 analysis of_requirementsspecification
03 analysis of_requirementsspecificationRebecca Jones
 
Software development slides
Software development slidesSoftware development slides
Software development slidesiarthur
 
POS 408 Education Specialist / snaptutorial.com
POS 408 Education Specialist / snaptutorial.comPOS 408 Education Specialist / snaptutorial.com
POS 408 Education Specialist / snaptutorial.comMcdonaldRyan107
 
POS 408 Effective Communication - tutorialrank.com
POS 408  Effective Communication - tutorialrank.comPOS 408  Effective Communication - tutorialrank.com
POS 408 Effective Communication - tutorialrank.comBartholomew58
 
Kelis king - requirements analysis and the unified process
Kelis king - requirements analysis and the unified processKelis king - requirements analysis and the unified process
Kelis king - requirements analysis and the unified processKelisKing
 
POS/408 ENTIRE CLASS UOP TUTORIALS
POS/408 ENTIRE CLASS UOP TUTORIALSPOS/408 ENTIRE CLASS UOP TUTORIALS
POS/408 ENTIRE CLASS UOP TUTORIALSSharon Reynolds
 
Pos 408 Social Responsibility - tutorialrank.com
Pos 408  Social Responsibility - tutorialrank.comPos 408  Social Responsibility - tutorialrank.com
Pos 408 Social Responsibility - tutorialrank.comPrescottLunt1008
 
Fundamentals of software development
Fundamentals of software developmentFundamentals of software development
Fundamentals of software developmentPratik Devmurari
 
Sudheer_SAP_ABAP_Resume
Sudheer_SAP_ABAP_ResumeSudheer_SAP_ABAP_Resume
Sudheer_SAP_ABAP_ResumeSudheer babu
 
SAP BI Requirements Gathering Process
SAP BI Requirements Gathering ProcessSAP BI Requirements Gathering Process
SAP BI Requirements Gathering Processsilvaft
 
Computer concepts
Computer conceptsComputer concepts
Computer conceptsImran Waris
 
software development and programming languages
software development and programming languages software development and programming languages
software development and programming languages PraShant Kumar
 
Behaviour Driven Development V 0.1
Behaviour Driven Development V 0.1Behaviour Driven Development V 0.1
Behaviour Driven Development V 0.1willmation
 

Similaire à Software Design Documentation (20)

03 analysis of_requirementsspecification
03 analysis of_requirementsspecification03 analysis of_requirementsspecification
03 analysis of_requirementsspecification
 
Sad presentation
Sad presentationSad presentation
Sad presentation
 
Sd Revision
Sd RevisionSd Revision
Sd Revision
 
10tait
10tait10tait
10tait
 
Chapter 10
Chapter 10 Chapter 10
Chapter 10
 
James hall ch 14
James hall ch 14James hall ch 14
James hall ch 14
 
Software development slides
Software development slidesSoftware development slides
Software development slides
 
cheatsheet.pdf
cheatsheet.pdfcheatsheet.pdf
cheatsheet.pdf
 
POS 408 Education Specialist / snaptutorial.com
POS 408 Education Specialist / snaptutorial.comPOS 408 Education Specialist / snaptutorial.com
POS 408 Education Specialist / snaptutorial.com
 
POS 408 Effective Communication - tutorialrank.com
POS 408  Effective Communication - tutorialrank.comPOS 408  Effective Communication - tutorialrank.com
POS 408 Effective Communication - tutorialrank.com
 
Kelis king - requirements analysis and the unified process
Kelis king - requirements analysis and the unified processKelis king - requirements analysis and the unified process
Kelis king - requirements analysis and the unified process
 
POS/408 ENTIRE CLASS UOP TUTORIALS
POS/408 ENTIRE CLASS UOP TUTORIALSPOS/408 ENTIRE CLASS UOP TUTORIALS
POS/408 ENTIRE CLASS UOP TUTORIALS
 
Pos 408 Social Responsibility - tutorialrank.com
Pos 408  Social Responsibility - tutorialrank.comPos 408  Social Responsibility - tutorialrank.com
Pos 408 Social Responsibility - tutorialrank.com
 
PRELIM-Lesson-2.pdf
PRELIM-Lesson-2.pdfPRELIM-Lesson-2.pdf
PRELIM-Lesson-2.pdf
 
Fundamentals of software development
Fundamentals of software developmentFundamentals of software development
Fundamentals of software development
 
Sudheer_SAP_ABAP_Resume
Sudheer_SAP_ABAP_ResumeSudheer_SAP_ABAP_Resume
Sudheer_SAP_ABAP_Resume
 
SAP BI Requirements Gathering Process
SAP BI Requirements Gathering ProcessSAP BI Requirements Gathering Process
SAP BI Requirements Gathering Process
 
Computer concepts
Computer conceptsComputer concepts
Computer concepts
 
software development and programming languages
software development and programming languages software development and programming languages
software development and programming languages
 
Behaviour Driven Development V 0.1
Behaviour Driven Development V 0.1Behaviour Driven Development V 0.1
Behaviour Driven Development V 0.1
 

Plus de nicky_walters

Plus de nicky_walters (9)

Pseudocode flowcharts
Pseudocode flowchartsPseudocode flowcharts
Pseudocode flowcharts
 
Data types vbnet
Data types vbnetData types vbnet
Data types vbnet
 
Ndu06 typesof language
Ndu06 typesof languageNdu06 typesof language
Ndu06 typesof language
 
Event driventheory
Event driventheoryEvent driventheory
Event driventheory
 
Debugging
DebuggingDebugging
Debugging
 
Input output
Input outputInput output
Input output
 
Decisions
DecisionsDecisions
Decisions
 
Intro to visual studio 2008
Intro to visual studio 2008Intro to visual studio 2008
Intro to visual studio 2008
 
Input output
Input outputInput output
Input output
 

Software Design Documentation

  • 2. Software Development Lifecycle This is used by software designers - the whole design process can be thought of as a cycle The stages are: Identify - Define requirements and specification Design - Plan the solution to the problem Develop - Produce the program code Test - Locate and remove any errors Evaluate - Review against program requirements 2
  • 3. Identify the Scope The first stage of the design process is based upon analysing the user’s requirements to determine what is achievable with the resources available. Resource limitations (called constraints) usually involve time and money. Prioritise the most important features and decide what will be included in the first version of the software and what can be left out and put on the ‘wish list’ for future versions. You then need to produce a formal written requirements specification for the program 3
  • 4. Design Documentation Requirement Specification: Inputs are required from the user Outputs expected by the user Processing needed to provide functionality Constraints e.g. time, funds, specialist skills Screen Designs Program Design: Modules and Algorithms: Structure Diagram / Flowcharts / Pseudocode Data Dictionary Test Plan 4
  • 5. Requirements Specification Inputs: List of all the data that is input by the user Give specific details of the actual data, e.g. first name and last name of user Identify valid and invalid values for text and acceptable ranges for numeric data Outputs: List of all output expected by the user Give specific details of the actual data and format, e.g. Monthly sales report which will be displayed in a bar chart, showing total sales for each product Include any help information e.g. Instructions, error messages or visual feedback 5
  • 6. Requirements Specification Processing: Give details of all the functions the program will need to have. You should break this down into each processing task e.g. validation, calculations, formatting etc. Explain what each function should do (not how – yet!) There could be many of these in your proposed system Constraints: Identify any resource limitations It could include budget, development timescales, hardware available, training requirements, special needs of users etc. Give specific details of each, e.g. The total budget available is £50,000 6
  • 7. Screen Designs Provide a storyboard to show screens at various stages of the program Draw them… Count Down On paper… In Word or Visio… In Visual Studio… They must show The prompts the user will see Example input Example output 7
  • 8. Process Specification Requirements Specification - describes WHAT the system must be able to do. Process Specification - provides details of HOW the required functionality is achieved. Various techniques used to clarify procedures Flow Charts Structure Diagram Pseudocode / Structured English Provides the logical design for a computer algorithm Not language specific 8
  • 9. Data Dictionary This is used to document the variables and data types used in your program Show the variable names, datatypes and a description of what data the variable is going to store Identify location e.g. Local or Global Remember local is better 9 9
  • 10. A Data Dictionary Table with details of all important variables Variable DataType Description VAT Global Single, Constant Holds current VAT rate (17.5%) sngVATPrice Local to Single Holds price of goods Checkout inc VAT intQuantity Local to Integer Number of items Checkout 10