Procedure and Work Instruction MIT LABs 신미령 200730360 Procedures and work instructions

Procedure와 Work Instruction의 필요성 Work Instruction과 Procedure의 개발을 위한 개념적 계층관계. A conceptual hierarchy for development of procedures and work instructions p.s. : procedure: Procedure (control plan-혹은 통제계획) A procedure is “a particular way of accomplishing something or of acting”. In other words, procedures, as transmitted in documents, are the detailed activities or processes to be performed according to a given method for the purpose of accomplishing a task. Work instructions are used mainly in cases where a uniform method of performing the task throughout the organization is either impossible or undesirable. As a result, work instructions are specific to a team or department; they supplement procedures by providing explicit details that are suitable solely to the needs of one team, department or unit. 그림14.1 presents a conceptual hierarchy frequently used to govern development of procedures and work instructions. Professionally developed and maintained SQA procedures are required to conform to the organization’s quality policy but also tend to conform to international or national SQA standards. the difference between procedures and work instructions. Procedures define the activities performed in order to achieve given tasks, where performance is universal to the entire organization. Work instructions are complementary tools, used to define local variations in the application of the procedures by specific teams and/or departments. Work instructions, however detailed and targeted, cannot contradict the organization’s procedures.

Procedure와 Work Instruction의 필요성 SQA Procedure와 Work Instruction의 목표 요구한 품질을 벗어나지 않고 최대의 효과적인 방법을 사용한 작업, 과정과 행동의 성능. 소프트웨어 시스템의 개발과 유지에 나누어서 참여하고 있는 스텝들 사이의 효과적인 교류. 균일한 성능, Procedure와 Work Instruction를 따라서 이루고, 소프트웨어 에러를 야기하는 오해를 감소시킨다. 조직에 있는 여러 사람들이 수행한 작업들과 행동들 사이의 간단한 조정. 더 나은 협력은 에러가 덜 생김을 뜻한다. SQA procedures and work instructions aim at: Performance of tasks, processes or activities in the most effective and efficient way without deviating from quality requirements. Effective and efficient communication between the separate staffs involved in the development and maintenance of software systems. Uniformity in performance, achieved by conformity with procedures and work instructions, reduces the misunderstandings that lead to software errors. Simplified coordination between tasks and activities performed by the various bodies of the organization. Better coordination means fewer errors. p.s. : the contribution of procedures to software quality assurance. SQA procedures are assumed to reflect the most adequate method known to date for the performance of design and maintenance activities. SAQ procedures that are up-to-date and fully implemented by developers and maintenance teams assure conformity of their activities to the software’s quality requirements and performance of the associated activities in an efficient and effective performance. At the same time, uniform development and maintenance enables easier and more effective professional review together with better communication with the maintenance team. It likewise facilitates cooperation and coordination between all the bodies, internal and external, involved in the project. Not less important is the reduction in errors made possible by uniformity.

Procedures The Five W’s: 문제를 Procedure를 통해서 해결 Frame14.1 The Five W’s: issues resolved by procedures What activities have to be performed? HoW should each activity be performed? When should be activity be performed? Where should the activity be performed? Who should perform the activity? Frame14.2 Fixed table of contents for procedures Introduction * Purpose Terms and abbreviations * Applicable documents Method Quality records and documentation Reporting and follow-up * Responsibility for implementation * List of appendices * Appendices * * Sections included only if applicable Procedures The Five W’s: issues resolved by procedures Fixed table of contents for procedures p.s. : Procedures supply all the details needed to carry out a task according to the prescribed method for fulfilling that task’s function. These details can be viewed as responding to five issues, known as the Five W’s, listed in the Frame 14.1. Standardization – the application of a fixed format and structure – is the principle applied to all SQA procedures. A typical example for a fixed table of contents that can be used for all the organization’s procedures is presented in Frame 14.2.

Procedures manual SQA Procedures manual: 목차 Table 14.1: SQA procedures manual: table of contents ISO 9000.3 – table of contents SQA procedures manual – table of contents 4.1 Managerial responsibility 1.1 The company’s SQA policy 1.2 Management quality review 4.2 Quality system 2.1 The SQA organization 2.2 Procedures and work instructions – preparation, approval and distribution 2.3 The annual quality planning 4.3 Contract review 3.1 Contract review 4.4 Design control 4.1 Development and quality plans 4.2 Quality assurance of the design 4.5 Document and data control 5.1 Document control 4.6 Purchasing 6.1 Subcontractors and suppliers file management 6.2 Pre-contract review for subcontractor proposal 6.3 Acceptance tests for subcontracted software 4.7 Control of customer-supplied products 7.1 Acceptance tests for customer-supplied software 4.8 Product identification and traceability 8.1 Configuration management 4.9 Process control 9.1 Software development process Table 14.1: SQA procedures manual: table of contents p.s. : The collection of all SQA procedures is usually referred to as the SQA procedures manual. The contents of any one organization’s procedures manual varies according to: The types of software development and maintenance activities carried out by the organization The range of activities belonging to each activity type The range of customers (e.g., internal, customers of custom-made software, COTS software customers) and suppliers (e.g., self-development and maintenance, subcontractors, suppliers of COTS software and reused software modules) The conceptions governing the choice of method applied by the organization to achieve desired SQA objectives. The organization’s manual divides procedures into categories according to the corresponding ISO standard sections.

Procedures manual Table 14.1: Continued ISO 9000.3 – table of contents SQA procedures manual – table of contents 4.10 Inspection and testing 10.1 Unit tests and integration tests 10.2 Software system tests 10.3 Customer’s acceptance tests 4.11 Control of inspection, measuring and test equipment - Not applicable 4.12 Inspection and test status 12.1 Progress control for software development project 4.13 Control of non-conforming product 13.1 Control of design and code corrections 4.14 Corrective and preventive actions 14.1 Corrective and preventive actions 4.15 Handling, storage, packaging, preservation and delivery 15.1 Installation and delivery 4.16 control quality records 16.1 Control of quality records 4.17 Internal quality audits 17.1 Internal quality audits 4.18 Training 18.1 Training and certification of employees 4.19 Servicing 19.1 Maintenance plan 19.2 Change requests management 19.3 Dealing with customers’ complaints 4.20 Statistical techniques 20.1 Quality metrics 20.2 Quality assurance costs

Work Instruction과 Work Instructions manual SQA Work Instruction 주제 – 예제 Frame14.3 SQA work instructions subjects – examples Departmental work instructions Audit process for new software development subcontractors (supplier candidates) Priorities for handling corrective maintenance tasks Annual evaluation of software development subcontractors On-the-job instructions and follow-up for new team members Design documentation templates and their application C++ (for other language) programming instructions Project management work instructions Coordination and cooperation with the customer Weekly progress reporting by team leaders Special design report templates and their application in the project Follow-up of beta site reporting Monthly progress reporting to the customer Coordination of installation and customer’s team instructions SQA work instructions subjects – examples p.s. : As mentioned above, work instructions deal with the application of procedures, adapted to the requirements of a specific project team, customer, or other relevant party. While general methodology is defined in a procedure, the precise details that allow its application to a specific project or unit are often laid out in a work procedure. In no case can work instructions contradict their parent procedure, although several instructions can be associated with any given procedure. This means that one can add, change or cancel work instructions without altering the respective procedure. Examples of work instructions, summarized in their titles, are found in Frame 14.3.

Procedure와 Work Instruction: 준비 새로운 SQA Procedure 편람을 개발할 때 최소의 단계는 개념과 조직 구조를 처리하여 제의하던 Procedure와 누가 그들의 준비, 갱신과 면허를 책임을 있는지를 결정한다. 다음의 걸음은, 당연히, 구체적인 절차를 처리하다. Procedures 준비에 관한 일반적인 접근은 각자의 주제를 처리하는 관련 유니트에서 일하는 전문적인 특별 위원회, SQA 유니트 구성원과 전문가를 임명하는 것이다. Preparation of new procedures The initial steps taken in development of a new SQA procedures manual should deal with the conceptual and organizational frameworks that determine the menu of the proposed procedures and who will be responsible for their preparation, updating and approval… The subsequent steps will, naturally, deal with specific procedures. A common approach to preparation of procedures is the appointment of an ad hoc committee of professionals working in the units involved, SQA unit members and experts in the respective topics to be dealt with. p.s. : An “active” SQA procedures manual conceals numerous, often ongoing activities that guarantee the procedures’ continued applicability: for instance, preparation of the procedures, their implementation and regular updating. These ongoing activities performed by SQA team members together with members of the teams and organizational units involved, assure that the procedures are properly adapted to changes in technology as well as clientele and competition. …This framework is usually also formulated as a procedure (frequently called the procedure of procedures). The committee pours over the proposed drafts until a satisfactory version is reached, and ceases its work only after the procedure is approved by the authorized person(s). An alternative approach to procedure manual preparation is dependence on consulting, where an outside expert is assigned the responsibility of preparing one procedure, some procedures or the complete manual. The main advantages of employing a consultant are found in the added value of his or her expertise and experience in other organizations, the reduced burden on the organization’s senior professionals as well as the shortened task completion timetable. The main disadvantage experience with this approach is reduced applicability due to the organization’s unique characteristics.

Procedure와 Work Instruction: 실행 많은 case에서 인쇄물이나 email 형태로의 자료 분할과 team이나 unit의 instruction은 완벽히 혹은 거의 완벽히 적합함을 보이기 위해 불충분 한다. 한 팀이나 부분의 멤버들은 새로운 요구를 위해 그들의 동료를 납득 시키려 도와주는 Procedure 준비하는 과정에서 혼란스러워진다. 새로운 프로시저의 follow-up과 individual instruction은 매일 반복되는 것(daily routines) 없는 프로듀서의 통합을 위해서 필수적이다. Implementation of new or revised procedures: In many cases, distribution of the material in printed or e-mail form and instruction of the team or unit are insufficient to assure full or nearly full conformity. The fact that members of a team or department were involved in the procedure’s preparation helps convince their colleagues to abide by the new requirements but this, too, is often inadequate. Follow-up and individual instruction of those who lack or disregard the new procedure is mandatory for the procedure’s integration within daily routines. p.s. : Approval of a new or revised procedure says little about the ease of that procedure’s implementation, which is a separate and often difficult issue.

Procedure와 Work Instruction: 갱신 개발 tool, 하드웨어, 통신 장치에 따라서 기술이 바뀐다. 조직 영역의 행동에 따라서 변경된다. 개선을 위한 사용자 제의 실패와 성공의 분석 내부 감사 report에 의해 시작된 구현 계회 다른 조직의 경험으로부터 배운다. SQA 팀의 경험 Updating procedures Technological changes in development tools, hardware, communication equipment, etc. Changes in the organization’s areas of activity User proposals for improvement Analysis of failures as well as successes Proposals for improvements initiated by internal audit reports Learning from the experience of other organizations Experiences of the SQA team p.s. : The motivation to update existing procedures is based, among other things, on the following:

Topics for Discussion-1 "wind Solutions"는 250여명의 직원이 고용된 중(中)형의 소프트웨어 개발사이다. 신임 SQA 매니저가 아주 오래되고 진부한 Procedure를 대신해 몇개의 새로운 Procedure를 준비하기로 결심하였다. 당신은 "Progress control of software development projects"라 명명된 Procedure의 초안을 준비하는 그(매니저)의 작업에 동참하자는 의뢰를 받았다. 이 Procedure는 다음과 같은 주제들을 처리해야 한다. 시간표, 인력 자원에 대한 활용 계획과 예산에 대한 준비 프로젝트에 대한 회사의 각 파트별 진도 보고서 프로젝트에 대한 하청회사, 파트너, 발주자의 각 파트별 진도 보고서 진도 보고서를 위한 control process 시간표, 인력 자원에 대한 활용 계획과 예산에 대한 updating 회사의 시간표, 인력자원에 대한 계획 불이행에 대한 대응 하청업체의 시간표, 인력자원에 대한 계획 불이행에 대한 대응 파트너나 발주자의 시간표, 인력자원에 대한 계획 불이행에 대한 대응 당신이 가정한 회사의 조직 도표를 스케치하라. 이 도표가 당신의 Procedure 초안을 대신하게 될 것이다. "Progress control of software development projects" Procedure의 초안을 준비하라. 이 Procedure에 위 의 8개 주제를 모두 포함시켜야 한다. 필요하면 부록을 추가하라. 이 Procedure에 관한 당신의 가정들을 열거하라. 14.2 “Wild Solutions” is a medium-sized software house, employing about 250 staff, The new SQA manager has decided to prepare several new procedures to replace very old and outdated procedures. You are asked to join him in his efforts and prepare a draft for the procedure entitled “Progress control of software development projects” The procedure should deal with the following subjects. Preparation of a timetable, manpower resources usage plan and budget Progress reporting for those parts of the project carried out by the company Progress reporting for those parts of the project carried out by the subcontractors, partners and the customer(s) Control process for progress reporting Updating of the timetable, manpower resources usage plan and budget Responses to deviations from the timetable, manpower resources usage plan and budget in parts carried out by the company Responses to deviations from the timetable, manpower resources usage plan and budget in parts carried out by subcontractors Responses to deviations from the timetable, manpower resources usage plan and budget in parts carried out by partners or customers. Sketch what you imagine to be the company’s organizational chart. The chart will serve for your procedure draft. Prepare a draft of the “Progress control of software development projects” Procedure. The procedure should cover all eight subjects listed above. Add appendices if required. List your assumptions regarding the procedure.

Company’s organizational chart:

SQA Procedure: Progress control of software development projects procedure Purpose To define the process for progress control of software development projects procedure. Scope The Procedure will apply to all software development projects. Applicable documents (undetermined) Method 4.1 Preparation of a timetable, manpower resources usage plan and budget 4.2 Progress reporting for those parts of the project carried out by the company 4.3 Progress reporting for those parts of the project carried out by the subcontractors, partners and the customer(s) 4.4 Control process for progress reporting 4.5 Updating of the timetable, manpower resources usage plan and budget 4.6 Responses to deviations from the timetable, manpower resources usage plan and budget in parts carried out by the company 4.7 Responses to deviations from the timetable, manpower resources usage plan and budget in parts carried out by subcontractors 4.8 Responses to deviations from the timetable, manpower resources usage plan and budget in parts carried out by partners or customers. Quality records and documentation (undetermined)

Topics for Discussion-2 QA 유니트 맴버로서,당신에게 새로운 Procedure의 첫 초안을 준비하도록 요구했다. 초안을 준비할때 사용되어야할 어떠한 정보들의 출처들은 무엇이 있는지 제안하라. 1의 답에서 언급한 것중 좋은 초안에 가장 중요한(essential) 출처들을 표시하라. 14.3 As an SQA unit member, you are required to prepare the first draft of a new procedure. Suggest what sources of information may be used to prepare the draft. Mark those sources mentioned in your answer to (1) that are essential for a good graft.

sources of information: International or national SQA standard The Organization’s SQA policy conceptual and organization frameworks manpower resources software’s quality requirements task’s function p.s.: Professionally developed and maintained SQA procedures are required to conform to the organization’s quality policy but also tend to conform to international or national SQA standards. Procedures: preparation The initial steps taken in development of a new SQA procedures manual should deal with the conceptual and organizational frameworks that determine the menu of the proposed procedures and who will be responsible for their preparation, updating and approval… The subsequent steps will, naturally, deal with specific procedures. A common approach to preparation of procedures is the appointment of an ad hoc committee of professionals working in the units involved, SQA unit members and experts in the respective topics to be dealt with. for instance, preparation of the procedures, their implementation and regular updating. These ongoing activities performed by SQA team members together with members of the teams and organizational units involved, assure that the procedures are properly adapted to changes in technology as well as clientele and competition. Procedures supply all the details needed to carry out a task according to the prescribed method for fulfilling that task’s function. These details can be viewed as responding to five issues, known as the Five W’s, listed in the Frame 14.1.

Topics for Discussion-2 새롭고 갱신된 Procedure를 준비하는 것은 SQA 유니트의 전문가 혹은 컨선턴트가 하는 것보다 특별 위원회를 구성하여 하는 것이 낫다. 새로운 Procedure를 준비할때 "committee"옵션에 기대되는 장점들을 열거 하라.이 단계에서 전문가를 신임하는 옵션이 어떤 장점있을까? 실행 단계에 들어가쓸때 "committee"옵션에 기대되는 장점들을 열거 하라. 14.4 It is recommended that the new and updated procedures be prepared by an ad hoc committee rather than by an expert member of the SQA unit or a consultant. List the expected advantages of the “committee” option in preparing new and updated procedures. Does reliance on “expert” option have any advantages at this stage? List the expected advantages of the “committee” option to be realized in the implementation stage.

The advantages of the “expert” option In preparing new and updated procedures, The advantages of the “committee” option The main advantages of employing a consultant are found in the added value of his or her expertise and experience in other organizations. the reduced burden on the organization’s senior professionals as well as the shortened task completion timetable. The advantages of the “expert” option The main disadvantage experience with this approach is reduced applicability due to the organization’s unique characteristics. In the implementation stage, The advantages of the “committee” option The members of a team or department were involved in the procedure’s preparation helps convince their colleagues to abide by the new requirements.