Software Life cycle discussion

Slide Deck

Download the slide deck from here.

Video Transcript

Hello, this is Amir Shehata with another quick tip on the LUTF.

Today I'd like to express my thoughts on the software processpropose a new way of working, which could prove advantageous.

Problems with the Traditional Software Development Model

We all learnt the waterfall model at school. I don't know about you, but in practice it is never that clean.

...

As we write the HLD, we find we need to role back and adjust the requirements. The Detailed design is often passed over in favour of going directly to implementation, which I can't really disagree with.

The Test Plan is written at the very end.

...

The trick is to reduce the cost of the solution and maximize the benefit.

Proposed Solution

My proposed solution is to bring the test plan development to the centre of the Software Development ProcessCycle.

A well formed requirement must be testable. Therefore we can represent each requirement as a test case.

...

We can add extra test cases during the design phase as needed. The These test cases would test existing requirements or add could represent new requirements we didn't think of before.

We When we move to implementation (either after the design phase is completed or in parallel) and we can still add extra test cases as needed. Again these test cases can test existing requirement or add new onesrepresent new requirements.

This can happen all the way down to the bug fixing phase.

Once the feature is complete we should have a set of test scripts which represent both the requirements, test plan and parts of the design.

We can conceivably then extract all the information needed for these documents.

The LUTF Involvement

Let's now imagine that all these test scripts, which include:

...

I believe this reduces the overhead and increases our chances of keeping documentation consistent with the implementation.

The LUTF Documentation Block

Now to some LUTF details

Each test script should include a documentation block. Not all elements shown here are needed. But the more complete it is the more complete the generated document will be.

Here are the different fields in the documentation block:

"""
@PRIMARY: Primary Requirement ID
@PRIMARY_DESC: Textual description of the primary requirement
@SECONDARY: Secondary Requirement ID if it exists
@SECONDARY_DESC: description  of the Secondary Requirement if it exists
@DESIGN: Design details
@TESTCASE: Test case description
"""

It's enclosed in """ .

The LUTF can automatically generate the bulk of the requirements, HLD and test plan documentation from the test scripts.

This method provides the glue between the code and the documentation. As bugs are fixed or the feature updated, the developer should create new test cases to cover the changes made and regenerate the documentation.

The LUTF can generate documentation with the create_docs() command.

suites['samples'].create_docs("samples.csv")

This will generate three csv files one would be the requirement document with the design and the other is the test plan.

Requirement Document

...

HLD

...

Test Plan

...

NOTE: each secondary requirement in a test case should be a primary requirement in another test case. The idea here is that some test cases might touch on more than one requirement.

The csv files can then be imported directly into the Confluence wiki or embedded in a document.

Once the test plan is reviewed, updated and approved, the script logic can be written in a separate phase.

Caveat

Of course life is always more complicated that it appears on paper.

Diagrams and other mediums might be needed to explain the requirements and the design, which can not be included in a text only test scriptform.

However, my argument is that the above process can alleviate much of the required document maintenance of the documents required.

Lets Let's take the Requirements document as an example.

...

Updates to the second section of the document can be automatically generated from the test scripts.

Demonstration

Let's look at how all this would look like in the LUTFThis method provides the glue between the code and the documentation. As bugs are fixed or the feature updated, as long as the developer creates new test cases to cover the changes made and regenerate the documentation, the code and the documentation will remain in sync.