standar dokumentasi software

Evi Septiana, MT pyrena_eve@yahoo.com, pyrena.eve@gmail.com

HP. 0856 304 2636, 031 71770292

Fullname : Evi Septiana Pane (Evi, Rena) Birth date : 27th Sept 1985 Current Address : Kebonsari, Candi, Sidoarjo Marital Status : Married, one child Education : Bachelor Degree of Information System

@ ITS Surabaya (2003), Master Degree of Telematics @ ITS Surabaya (2008)

Work Experience : Documentator of GRMS (Government Resource Management System) Software @ Bagian Bina Program Pemkot Surabaya (2008 – early 2010)

Last Work : Staff Program & Kerjasama Diklat @ Balai Diklat Industri Reg. V Surabaya (2008 – now)

To understand What and Why we need Software Documentation

To understand Standard Documentation Software

To implement simple example of Software Documentation

Documentation is needed in this phase of SDLC

Software User manual or Software Development Document ? both of them

Shall be made or not ? yes, absolutely What the importance of software

documentation ? go to the next slide

To manage the increased complexity and changing nature of software development

For communication between designer, programmer, PM, customer, and end-users

For continous improvement in software development

• Record the process of development and maintenance.

• Plans, schedules, process quality documents and organizational and project standards are process documentation.

Process Documentation

• Describes the product that is being developed.

• System documentation describes the product from the point of view of the engineers developing and maintaining the system;

Product Documentation

Project Leader

Programmer Analyst Tester Coding and debug

program Collect User Req. Analize User Req.

Testing the program Give feedback to

programmer

Responsible for all activity in project

10

E-Learning ? E-Learning as Software E-Learning failure in requirement analysis E-learning developer failure to capture user needs

• Requirements The requirements are the set of all needs, and are the basis for later development

• Why can’t we get requirements right? …

Requirements are the voice of the customer They’re hard to get right

Coz, the user doesn’t always know what they want !

Functional Requirements

• Describe what the system should do

• What inputs/outputs

• What data the system should store

• What computations the system should perform

• Concepts, functions, features, information, Behaviors. These are generally listed as shall statements starting with “The system shall ...”.

Non- Functional Requirements

• Constraints that must be accomplished or adhered to ...

• Response time

• Throughput

• Resource usage

• Reliability

• Availability

• Security

• Recovery from failure

• Cost

• Technology to be used

Other Requirements

• Enviromental Requirements

• Schedulling Requirements

General tools : word processors, spreadsheets..

(+) Flexible, ubiquitous

(-) Poor traceability & other support, difficult to maintain

Requirements tools : Rational rose, Power designer,..

(+) Good tracking etc. support , structured

(-) Inflexible, overkill for small projects

Graphical. UML, DFD, ERD, ...

(+) Widely used?

(-) Have a loose semantics

UML (Unified Modelling Languages)

Is a standard language for visualize, design, and documenting a software.

Usually used in SRS : usecase diagram & class diagram ERD (Entity Relationship Diagram)

Is an abstract and conceptual representation of data

DFD (Data Flow Diagram)

graphical representation of the "flow" of data through an information system. DFDs can also be used for the visualization of data processing (structured design).

Complete description of the behavior of a system to be developed

The basic issues that the SRS writer(s) shall address are the following: Functionality.

External interfaces.

Performance.

Attributes.

Design constraints imposed on an implementation.

is a translation from SRS to the description of software structure, software component, interface and data that important in implementation phase.

SDD is a detail blueprint for implementation activity.

The main target audience of this document is programmer..

Tools widely used in Project Management

Plan Microsoft Project

Make 4 group consist of 5 people, Get Requirement from the following system :

….

Academic information system online

Digital library

E-Learning

Create usecase diagram and ER Diagram from the system above

Discussion time 30 min

1. IEEE Std 830-1998 IEEE Recommended Practice for Software Requirement Specification

2. IEEE Std 1016-2009 IEEE Recommended Practice for Software Design Descriptions

3. IEEE Std 1058-1998 IEEE Recommended Practice for Software Project Management Plan

4. www.wikipedia.org