Qualsys Documentation:

Reflections

How, what, where, when and why

ID: TG.G.DocnVersion: 1 Oct 2015Owner: Peter Pond

A few Qualsys Documents

• Data Sheets• Plans• User Requirements• Change Requests• User Guides• FAQs• Purchase Orders• Test records• Templates• Forms• Supplier records

• Staff leave records• Expense Claims• Meeting records• Contacts• Procedures• Emails• Requisitions• Test plans• Correspondence• Accounts

A short guide to effective documentation completed forms, videos, user guides, test records etc are all

documents

max of 16 steps to getting them right

User Guide needs all 16 stops

Completed Expenses form is the express with far fewer

comment on piece of code of causal JT

each documentation failure has an implicit cost

The 16 steps

Audience?

Form?

Format?

Objective?Medium?

Style?

Clarity?

Storage?

Confidence?

Security?Availability?

Review?

Disposal?

Approval?

Publicity?

Feedback?

The End

Audience

Stakeholders1. Potential clients

2. Technicians

3. Internal administrators

4. Auditors

5. Current clients

6. Colleagues

<-

Objectives

1. Know them

2. State them

3. Hide them

4. Trim them

5. <-

Medium

1. Web

2. Audio

3. Video

4. Required Form

5. System record

6. Email

7. MS Office

8. HTML

9. PDF

<-

Form• The poor man’s means of record keeping

• When is a form not a form?

• Our forms QF{nn} for odd specifics

<-

Format1. Some QF are templates eg

a. QF01 – Standard Word Docb. QF35 – Standard letterc. QF105 – Standard spreadsheet

2. QP08 - general guidance on formatting rules

3. House styles for many things eg

a. User Requirementsb. User Guidesc. Training Manualsd. Datasheetse. Case Studies

<-

Style

1. Formal

2. Technical

3. Persuasive

4. Informative

5. Informal

6. Helpful

<-

Clarity

1. “It means what it says…”

2. Validate accuracy

3. … and unambiguity

4. 05 Mar 2016

<-

Storage1. My silo (only in draft)

2. The corporate silo (QQMS kbase)

3. The application in QQMS a. Job Trackerb. Training Managerc. Audit Manager etc

4. The application named in QQMSa. Teamseerb. Jirac. Salesforce etc

5. C I A

<-

Confidentiality1. DCT takes the strain

2. Allow Modification, or not

3. Same principles if not in QQMS kbase

4. If client doc, protecting them

<-

Security1. Backup

2. Protection from prying eyesa. Passwordingb. Data sticks!c. Laptopsd. Permissions

3. If in doubt, ask

<-

Availability1. Ben Gunn

2. In a form that the audience can see

3. The Tree

4. The Keya. IDb. Keywords in Title or Scopec. DCT etc

<-

Review

1. A record’s a record’s a record, but

2. Tempus fugit – DCT to the rescue again

3. Document Reviewa. Follow your review instructionb. Delete if no longer neededc. If OK, move date of review on to next reviewd. Otherwise revise doc and upload new versione. Review date automatic if (d) above. f. Move date far on, if review no longer required

4. Audit trail

<-

Disposal

1. Everything will one day run its course

2. DCT strikes againa. Automatic deletionb. Email warningc. Can move the date ond. Archiving only

3. Audit trailing again

4. Client docs special attention

5. Paper docs also

<-

Approval

1. Validation and approval

2. DCT supports again

3. The audit trail as before

4. Or Job Tracker, or sim

<-

Publicity

1. Almost there

2. Not DCT again!a. Variable by Doc if not enforcedb. Can get audit trail of receiptc. Can include outsiders by email, but no document

access (yet)

3. Notify User<-

Feedback1. Surely that’s it

2. Where is P>D>C>A without Feedback?

<-