csHjavaB-2019

Explore

development workflow
development workflow

👩‍💻 workflow

⁠

How should a developer get started?

What tasks does the developer need to do?

⁠

The section in this page offer a guide to organising the activities a developer takes on.

How to use the project documentation.

How to create and develop the code which meets the project requirements.

⁠

📄 documentation

A successful developer knows what documentation to expect when coding a project.

The developer has the skills for accurately reading and completing the documentation.

⁠

Introduction

A project begins with the documentation.

This includes: descriptions, plans and lists that explain what the client is expecting from the project.

Problem description

Design: main steps and refinements, data flow

Source data

Test Data and test tables

Evaluation

How should you use the documentation to take the project forward?

A project is developed by completing some key tasks

Analysis,

Design,

Implementation (and debugging),

Testing,

Evaluation

A developer will often take on some parts with other stages completed by other developers.

The documentation supports development activities at all stages.

⁠

Analyse

The developer needs as overall understanding of what the purpose of the project is.

The problem description gives an introduction. It will usually detail the client or organisation and specific requirements.

⁠

Problem description (example)

Once a year a walking club asks all its members to submit the total number of miles they have walked. The club collates this information in a text file.

A section of the .txt file, which includes the names of members and the total miles they walked, is shown below.

The information in the file is then used to select prize winners.

Prizes will be awarded for:

the furthest distance walked

any members who have walked more than 70% of the furthest distance

A program is required to read the data for each member from the text file.

The program should use this data to find then display the furthest distance walked.

The names of every member who has walked more than 70% of the furthest distance should be written to an empty text file so that the file can be printed out later.

⁠

☝️Read the description.

Highlight key facts.

What data is involved? How is it organised, how much data?

part of the data file is shown, ( the entire file is supplied and can be checked to see how many lines there are).

What has to be done with the data?

⁠

Design

The design is a precise technical plan for the main and detailed steps to input, process and output the data.

It is a very clear description that directly leads to high level code.

Organised a main steps with a set of refinements; modular blocks each with a focus on one of the main steps.

Since the modules share some of the data, a data flow description is need to make clear what data must be passed between the modules.

top level algorithm (example)

A list of main steps.

Read members’ data from file into array of records

Find the furthest distance walked

Display the furthest distance walked

Write club prize winners to file

In this example there are four sequential steps, each step will have a refinement.

There will probably be data-flow between some steps.

There will be a procedure or function for each step, the group of four steps will become the top level procedure.

modular design and modular code

A good design often organises code into modules or blocks, each module has a focus on one main requirement of the project.

For example different modules for input, for output and for each main process (eg a standard algorithm).

An additional top-level module is used to organise (call) the other modules.

data flow diagram for modular design

A plan, perhaps diagram, describing what data must be passed from one module to another.

data-flow (example)

⁠

Loading…⁠

⁠

In this example the main steps are presented as module blocks

The IN-OUT arrows are naming the values and results that are required at each stage

Data flows from one module to the next

the furthest value is calculated by the second module and is passed to the third (and fourth) module

refinements (example)

⁠

👯 develop using parallel array

reading the data flow

setting up a data structure in Java

reading a CSV file into a set of parallel arrays

writing to a CSV file from parallel arrays

working with data from parallel arrays

traversing

accessing values in array elements

⁠

🗃️ develop using array of records

reading the data flow

setting up a data structure in Java

reading a CSV file into an array of objects (record array)

writing to a CSV file from array of objects (record array)

working with data from array of objects (record array)