On Software Development (or "O Sr. SiIva disse..."): INDEX: About Project Plans - The Hitchhiker's Guide to the Galaxy (of QMS / SDP Project Plans)

quinta-feira, 13 de outubro de 2016

INDEX: About Project Plans - The Hitchhiker's Guide to the Galaxy (of QMS / SDP Project Plans)

The Short Story

Plans, plans, plans…

Q: What kind of initial QMS / SDP-related documentation should it be created at project start (also called Kick-off)?

A: "Some" plans.

Plans, allow us to plan (which by the way everyone should do) and after approval, allow us to monitor and control the project execution against those same plans. PMs are responsible to approve them even though sometimes they will delegate their creation and maintenance to the TM and/or the most experienced SPAE (Software Product Assurance Engineer) in the team.

What plans are we talking about? The project Plan (and the related detailed plan), the QAP, the CMP, …

You'll hear of even more plans (depending on the standards we are being compliant with). Mainly it has to do with the fact that for some standards we have to plan even further (and deliver those plans so that the contractor knows how we plan - and later on, double check the execution of tasks in the plan, through the inspection of produced evidences). Examples of such standards are the ESA standards (ECSS, for space development), DO-178 (for airborne systems), CENELEC 50126 (for railway applications), and so on.

Examples of those include:

Software Verification Plan (SVP)
Software Validation Plan or (the mix of both):
Software Verification and Validation Plan (SVVP)

Another PA-related artifact is the PA Log book (sometimes called SPAE Logbook).

And Agile/Scrum projects use yet another log book: The sprint retro logbook.

What is the purpose of those main SDP plans?

What are their goals , when are they created, when should they be updated?

Before starting, one important thing to remember is the fact that there should be a public list of QMS Process Owners (PO) and some backups for that role (called Process Representatives - PRs).

One example of such a list can be found here (list of POs - INTERNAL): https://quality.critical.pt/SitePages/QMS-Unified/Process%20Owner%20and%20Process%20Representatives%20(Unified).aspx
TIP: If the process has not yet been "unified" (the status can be checked here): https://quality.critical.pt/SitePages/QMS-Unified/Alignment%20Status.aspx), you could have to look here: https://quality.critical.pt/SitePages/QMS/Process%20Owner%20and%20Process%20Representatives.aspx
Having the names, use the Beatles' song tip: "You know my name, look up the number" (in your company contacts database containing, place of work, phone contact and e-mail).

The (Very) Long Story

In order to know more about each artifact, the following "sequence of steps" is recommended:

Read one entry in the final table below; from there you get to know the QMS process to where it belongs;
Open the QMS Process and browse (at least) the main activities there described (typically there is only a single table/slide per process activity).
The plan/artifact in question should be an artifact of this process you've just opened and if not, it is because it probably is just updated by this process. It could be an AD of the process or not - you can check it at the end of the process document.
Open the template for the artifact (or the provided samples - if any), and scan read its contents. If some concrete examples are available also scan them. Google can also find them.
Read the associated guidebooks (or the instruction sheets in the spreadsheet files).
During this process, remember to list your questions / open issues so that in the end you can always go to the PO (or as a last resource the QD) and solve them.
The one million dollar final questions to answer are:

Am I able to create these documents from scratch?
Am I able to understand them and extract the needed information for the activities/tasks I will be performing for the project?
Do I know who to talk to in case of doubt (who is the doc owner? Who are the PO/PRs)?

INDEX: Plan / Artifact	Templates / Examples / Additional Relevant Docs
Templates (Docs from MT)	<<master template -- Quality Assurance Plan.docx>> <<master template -- Product Assurance Report.docx>> <<master template -- Int. Configuration Management Plan.docx>> <<master template -- Configuration Management Plan.docx>>
Templates (Spreadsheets)	<<internal QAP pre-tailored -- CSW-QMS-2013-TPL-00997-rd-pre-tailored-qap.xltx>> <<internal QAP -- PA Process -- CSW-QMS-2009-TPL-04681-quantitative-qap.xltx>> <<CSW-QMS-2014-TPL-01088-sprint-retrospective-workbook.xltm>> <<CSW-QMS-2007-TPL-0112-configuration-items-list.xltm>> <<CSW-QMS-2006-TPL-1126-spae-log-book.xltm>>
GBKs	<<CSW-QMS-2014-GBK-01269-agile-guidebook.pdf>> <<CSW-QMS-2012-GBK-04055-crucible-guidebook.pdf>> <<CSW-QMS-2012-GBK-02170-research-development-projects-tailoring.pdf>> <<CSW-QMS-2010-GBK-04838-review-report-macro.pdf>> <<CSW-QMS-2009-GBK-04120-wise-project-module-guidebook.pdf>> <<CSW-QMS-2009-GBK-03894-project-milestones-meetings.pdf>> <<CSW-QMS-2009-GBK-03591-qap-how-to.pdf>>
Relevant Trainings	<<project-management-practices-at-csw-internal-training.pptx>> <<CSW-QMS-2016-PRS-00605-QMSVerificationProcess2016DocumentandCodeR.pptx>> <<CSW-2015-PRS-00614-managing-baselines-and-change-control-tracking.pptx>> <<CSW-QMS-2015-TPL-00368-excel-project-tips-tricks.pdf>>

Artifact / Work Product (Plan)

Who is mostly involved

QMS Process / Doc. Level

Main Purpose

Artifact Doc Format / Tool

Generated by MT?

Example Doc. / Link

Associated Template and/or GBK / HOW-TO

More info (when to create, update and AOB)

AOB

Master Project Plan

PM Process (MAN.1)

High-level plan (Gantt chart with the main WBS of the project (similar to the one produced for the estimation sum-up sheet if created during proposal elaboration);

Relevant topics and uses for this artifact include: high level view of ptoject activities (overall view); end project date determination; resource balancing; critical path analysis; effort and cost estimation (use of PERT estimation techniques -Best Case Scenario, Expected Case Sc., Worst Case Sc.)…

MS Project (.mpp, etc.)

Web view of Gantt example (WISE projects module, project EXOMARSTGO: https://wise.critical.pt/wiseweb/projects/ProjectPlan.action?expandAllTasks=&_sourcePage=%2FWEB-INF%2Fjsps%2Fprojects%2FprojectPlan.jsp&id=7439&showDeliverables=true&showWorkpackages=true&allSelected=true&showMilestones=true)

For each project, the WISE export can be opened in MS Project: https://wise.critical.pt/wiseweb/projects/ExportProjectFile.action?id=7439

For MS Project planning tool info, tips and tricks, see training: https://my.critical.pt/humanresources/Documents/CSW-QMS-2015-TPL-00368-excel-project-tips-tricks.pdf

Should be always kept up to date (acc. To CRs/CCNs, approved changes to schedule, …); uploaded to "WISE Projects"; V1 ready at KOM (based on info from PRL, if existent)

Previously: There were ECS and ASD master plan templates as QMS artifacts.

A guide for the "WISE Project Module" (covering EVM indicators, managing baselines and more) can be found here:

https://quality.critical.pt/QMS%20PT/MAN-management/MAN-01-project-management/CSW-QMS-2009-GBK-04120-wise-project-module-guidebook.pdf

Detailed Project Plan

Typically: PM/TM

PM Process (MAN.1)

Used for detailed planning (day to day tasks, concrete resource allocations, % progress…)

MS Project (.mpp)

Optional: Created if a finer planning and control is needed (by the TM): details the Master Plan (and could be used to report %s progress for each task and calculate overal % progress, etc.)

N/A

Updated weekly (with progress)

External QAP

SPAE (PM typically delegates)

Software Product Assurance Process (MAN.8)

A written statement on how we intend to perform QA activities (i.e. how will the QMS apply to the project).

For instance: Describes the QA aspects of verification including

Review activities to be performed
Transition criteria for review activities

The external QAP is a doc; The internal QAP is a XLS (see entry in this table).

MS Word (Master template, template ID = TBD - empty at MT at the moment, reported PROCIMP-819);

Yes

See template TOC.

See template and "fill in the blanks";

see QAP GBK: https://quality.critical.pt/QMS%20PT/MAN-management/MAN-08-software-product-assurance/CSW-QMS-2009-GBK-03591-qap-how-to.pdf

Optional: If DL, it is created at KO; tailored with the QD (in case of doubt)

Note: This document could not be requested by the customer as deliverable (DL).

Internal QAP

SPAE

Software Product Assurance Process (MAN.8)

XLS that includes all process tailorings: e.g. Verification Process tailoring

Includes a record of all tailoring decisions e.g. How will verification be performed (e.g. will the project do code reviews?)? Validation? Reqs, Design and SW Construction?

Spreadsheet (see template ids at right)

See spreadhseet contents.

See XLS template:

https://quality.critical.pt/QMS%20PT/MAN-management/MAN-08-software-product-assurance/templates/CSW-QMS-2009-TPL-04681-quantitative-qap.xltx

Pre-Tailored for R&D project types: https://quality.critical.pt/QMS%20PT/MAN-management/MAN-08-software-product-assurance/templates/CSW-QMS-2013-TPL-00997-rd-pre-tailored-qap.xltx;

Also see the QAP GBK (link above)

Same as Ext. QAP

Old Ids:

CSW-QMS-2003-TPL-2570 (EN),

CSW-QMS-2004-TPL-2755 (PT)

CMP (External Config. Mg. Plan)

Typically: CM (Project Role; PM assigns this role to a team member)

CM Process (SUP.2)

A written statement on how we intend to do Config. Management (activities).

This document is optional but if done typically is to be delivered to the customer; this doc consolidates info in a single document some information already stated in other internal docs such as the ICMP, QAP, CIL, …

MS Word (Master template, template ID = CSW-QMS-2004-TPL-0234)

Yes

See template contents; check list contents

See template(s) and "fill in the blanks";

See CM checklist: https://quality.critical.pt/QMS%20PT/SUP-support/SUP-02-configuration-management/templates/CSW-QMS-2012-TPL-00068-cm-checkup-checklist.xltx

See training: https://my.critical.pt/humanresources/Documents/CSW-QMS-2016-PRS-00605-QMSVerificationProcess2016DocumentandCodeR.pptx (slides 17 and 18); helping scripts are referred there.

Optional: If DL, it is created at KO and kept up-to-date during the project (CRs/CCNs could impact this DL);

Note: This document could not be requested by the customer as deliverable (DL).

Template Variants: External and Internal; pre-tailored for certain life cycles: See doc list.

EN	[CSW-QMS-2004-TPL-0234]	{CMP}	Configuration Management Plan (CMP)
EN	[CSW-QMS-2006-TPL-3196]	{CMP}	Internal CM Plan (ICMP)
EN	[CSW-QMS-2013-TPL-01989]	{CMP}	Internal Maintenance Pre-Tailored CM Plan (ICMP)
EN	[CSW-QMS-2013-TPL-00995]	{CMP}	Internal R&D Pre-Tailored CM Plan (ICMP)

From <https://quality.critical.pt/SitePages/QMS-Unified/Master%20Template%20Content%20Detail%20(PT).aspx>

Internal CMP (ICMP)

CM (project role)

CM Process

The ICMP is a simpler document (when compared to the CMP) that includes the CM process tailoring decisions (what activities in the CM process are to be performed and what are not and with what formality and frequence) and the CM strategies (such as check-up strategy, build, baseline, tagging and branching strategies); it specifies the conventioned text for the TAGs to be applied at certain moments to the Version Control System (VCS).

MS Word (Master template, template ID = CSW-QMS-2006-TPL-3196; pre-tailored templates: CSW-QMS-2013-TPL-01989 (Maintenance); CSW-QMS-2013-TPL-00995 (R&D)

)

Yes

See template TOC and pre-tailored templates.

See above

As seen above, there are 3 ICMP templates being generated by the MT.

CIL

Typically: CM (PM approves)

Verification Process

Contains the review strategy (usually internal). It list internal and external configuration items under configuration (built from the proposal and including CFIs received from the customer - be it software or hardware, external input docs, etc.) and for the internal, how we plan to do the reviews.

Excel Template: CSW-QMS-2007-TPL-0112

See spreadsheet contents; see CM check list contents;

See XLS template, instructions sheet: https://quality.critical.pt/QMS%20PT/SUP-support/SUP-02-configuration-management/templates/CSW-QMS-2007-TPL-0112-configuration-items-list.xltm;

See training: https://my.critical.pt/humanresources/Documents/CSW-QMS-2016-PRS-00605-QMSVerificationProcess2016DocumentandCodeR.pptx (slides 17 and 18);

At KO; aligned with the DLs (and outputs) indicated in the PRL;

Typically the CM check list shall be ran before the end of each phase.

Sometimes the CIL info is included in the SVP (Software Verification Plan):

The SVP might be provided by the customer or be required by regulatory standards such as ECSS with the detailed review plan (i.e. while te CIL is typically internal, we could have one additional deliverable, the SVP)