UKOLN AHDS QA Focus Briefing Documents: Print All - QA



This page is for printing out briefing papers on QA. Note that some of the internal links may not work.


Briefing 30

Summary of the QA Focus Methodology


Background

In order to provide value for money and a return on investment from the funders there is a need for project deliverables not only to be functional in their own right but also to be widely accessible, easily repurposed and deployed in a service environment.

To achieve these aims projects should ensure that their deliverables comply with appropriate standards and best practices. Although it may be easy to require compliance, it may not always be easy to implement appropriate standards and best practices. In order to ensure that best endeavours are made it is recommended that projects should implement quality assurance (QA) procedures.

QA Focus's Methodology

Projects may be concerned that implementation of QA procedures can be time-consuming. The approach recommended by QA Focus is designed to be lightweight and to avoid unnecessary bureaucracy, while still providing a mechanism for implementation of best practices.

The QA Focus methodology is based on the following:

It is felt that use of this methodology should not only be beneficial to the projects themselves, but also help to minimise problems when project deliverables are re-used.

Example: QA For Web Sites

As an example of implementation of this approach the QA policy for standards for the QA Focus Web site is given below.

Area: Web site standards

Standards: The Web site will be based on the XHTML 1.0 and CSS 2.0 standards.

Architecture: The Web site will make use of PHP. XHTML 1.0 templates will be provided for use by authors, who will use simple HTML tools such as HTML-kit. Web site will provide access to an MS Access database. This will also comply with XHTML 1.0 and CSS 2.0 standards. The Web site will also host MS Word and MS PowerPoint files. These documents will also be available in HTML.

Exceptions: Resources converted from proprietary formats (such as MS Word and PowerPoint) need not necessarily comply with XHTML and CSS standards if doing so would be too time-consuming.

Responsibilities: The QA Focus project manager is responsible for changing this policy and addressing serious deviations from the policy.

Checking: Resources should be validated when they are created or updated usually using the ,validate tool. When several resources are updated the ,rvalidate tool should be used.

Audit trail: A full audit should be carried out at least quarterly. The findings should be published on the QA Focus Web site, and deviations from the policy documented.

A second example describes the QA policy for link checking of the QA Focus Web site.

Area: Web site: link checking

Best Practice: There should be no internal broken links and links to external resources should work when a page is created. We should seek to fix broken links to external resources. Exceptions: There may be broken links in historical documents or surveys. In addition, if remote Web sites are updated it may be too time-consuming to update the links.

Change Control: The QA Focus project manager is responsible for changing this policy and addressing serious deviations from the policy.

Checking: When resources are created or updated the resource should be link-checked, usually using the ,checklink tool. When several resources are updated the ,rchecklink tool should be used.

Audit trail: A full audit should be carried out at least quarterly. Initially two tools should be used to spot deficiencies in the link-checking software. The findings should be published on the QA Focus Web site, and deviations from the policy documented.

These two examples illustrate that developing QA policies need not be time-consuming. In addition implementation of these policies need not be time-consuming and can improve the quality of the Web site.


Briefing 37

Top 10 Quality Assurance Tips


The Top 10 Tips

1 Document Your Policies

You should ensure that you document policies for your project - remember that it can be difficult to implement quality if there isn't a shared understanding across your project of what you are seeking to achieve. For example, see the QA Focus policies on Web standards and link checking [1] [2].

2 Ensure Your Technical Infrastructure Is Capable Of Implementing Your Policies

You should ensure that your technical infrastucture which is capable of implementing your policies. For example, if you wish to make use of XHTML on your Web site you are unlikely to be able to achieve this if you are using Microsoft Word as your authoring tool.

3 Ensure That You Have The Resources Necessary To Implement Your Policies

You should ensure that you have the resources needed to implement your policies. This can include technical expertise, investment in software and hardware, investment in training and staff development, etc.

4 Implement Systematic Checking Procedures To Ensure Your Policies Are Being Implemented

Without systematic checking procedures there is a danger that your policies are not implemented in practice. For example, see the QA Focus checking procedures for Web standards and link [3] [4].

5 Keep Audit Trails

You should seek to provide audit trails which provide a record of results of your checking procedures. This can help to spot trends which may indicate failures in your procedures (for example, a sudden growth in the numbers of non-compliant HTML resources may be due to deployment of a new authoring tool, or a lack of adequate training for new members of the project team).

6 Learn From Others

Rather than seeking to develop quality assurance policies and procedures from scratch you should seek to learn from others. You may find that the QA Focus case studies [5] provide useful advice which you can learn from.

7 Share Your Experiences

If you are in the position of having deployed effective quality assurance procedures it can be helpful for the wider community if you share your approaches. For example, consider writing a QA Focus case study [6].

8 Seek 'Fitness For Purpose' - Not Perfection

You should seek to implement 'fitness for purpose' which is based on the levels of funding available and the expertise and resources you have available. Note that perfection is not necessarily a useful goal to aim for - indeed, there is a danger that 'seeking the best may drive out the good'.

9 Remember That QA Is For You To Implement

Although the QA Focus Web site provides a wide range of resources which can help you to ensure that your project deliverables are interoperable and widely accessible you should remember that you will need to implement quality assurance within your project.

10 Seek To Deploy QA Procedures More Extensively

Rather than seeking to implement quality assurance across your project, it can be beneficial if quality assurance is implemented at a higher level, such as within you department or organisation. If you have an interest in more widespread deployment of quality assurance, you should read about the ISO 9000 QA standards [7].

References

  1. Policy on Web Standards, QA Focus, UKOLN,
    <http://www.ukoln.ac.uk/qa-focus/qa/policies/web/>
  2. Policy on Linking, QA Focus, UKOLN,
    <http://www.ukoln.ac.uk/qa-focus/qa/policies/links/>
  3. Procedures for Web Standards, QA Focus, UKOLN,
    <http://www.ukoln.ac.uk/qa-focus/qa/procedures/web/>
  4. Procedures for Linking, QA Focus, UKOLN,
    <http://www.ukoln.ac.uk/qa-focus/qa/procedures/links/>
  5. Case Studies, QA Focus, UKOLN,
    <http://www.ukoln.ac.uk/qa-focus/documents/case-studies/>
  6. Contributing To Case Studies, QA Focus, UKOLN,
    <http://www.ukoln.ac.uk/qa-focus/documents/case-studies/#contributing>
  7. Selection and Use of the ISO 9000:2000 family of standards, ISO,
    <http://www.iso.org/iso/en/iso9000-14000/understand/selection_use/selection_use.html>

Briefing 58

Implementing Your Own QA


About This Document

This document describes how you can implement your own quality assurance policies and procedures to support your development work.

The QA Focus Methodology

The QA Focus methodology aims to ensure that IT development work produces services which are widely accessible and interoperable. It seeks to do this by developing a quality assurance framework which developers can make use of.

As described in the QA Focus briefing document "Summary of the QA Focus Methodology" [1] the QA Focus methodology is based on:

Documented policies on standards and best practices:
If the standards and best practices are not documented it will be difficult to ensure best practices are implemented, especially in light of staff turnover, changing environments, etc.
Documentation of the architecture used:
A description of the architecture is needed to ensure that the architecture used to implement the system is capable of complying with the standards.
Documented exceptions:
There may be occasions when deviations from standards may be allowed. Such deviations should be documented and responsibility for this agreed.
Systematic checking:
It is necessary to document systematic procedures for ensuring compliance with standards.
Audit trails:
It can be helpful to provide audit trails which can help spotting trends.

Implementing Your Own QA

The QA Focus briefing document "Summary of the QA Focus Methodology" [1] provides examples of implementing QA in the areas of Web standards and link checking. In this document we provide a template which can be used for any relevant aspect of IT development work.

QA Template

The following template can be used for developing your own QA framework.

Area:
The area covered by the QA (e.g. Web, software development, usability, ...)
Standards:
The standards which are relevant to the area and which you intend to make use of.
Best Practises:
The best practices which are relevant to the area and which you intend to make use of.
Architecture:
The architecture you intend to use.
Exceptions:
A summary of the exceptions to best practices and recommended standards and a justification for the exceptions.
Change Control:
A description of the responsibility for changing this QA document and the process for changing the policy.
Checking:
A description of the systematic checking procedures which will ensure that you are complying with the policies you have established.
Audit trail:
A description of audit trails (if any) which provide a record your compliance checking, in order to identify any trends.

As can be seen this QA template is simple and straightforward to use. The QA Focus methodology recognises the lack of resources which can hinder the deployment of more comprehensive QA frameworks and so has developed a more light-weight approach.

Examples

Examples of use of this approach can be found on the QA Focus Web site, which includes details of QA policies and procedures in the areas of Web standards [2], linking [3], usage statistics [4] and instant messaging [5].

References

  1. Summary of the QA Focus Methodology, QA Focus, UKOLN,
    <http://www.ukoln.ac.uk/qa-focus/documents/briefings/briefing-30/>
  2. Policy On Web Standards, QA Focus, UKOLN,
    <http://www.ukoln.ac.uk/qa-focus/qa/policies/web/>
  3. Policy On Linking, QA Focus, UKOLN,
    <http://www.ukoln.ac.uk/qa-focus/qa/policies/links/>
  4. Policy On Usage Statistics, QA Focus, UKOLN,
    <http://www.ukoln.ac.uk/qa-focus/qa/policies/statistics/>
  5. Policy On Instant Messaging, QA Focus, UKOLN,
    <http://www.ukoln.ac.uk/qa-focus/qa/policies/instant-messaging/>