I Tal-Lab kan ingen höra dig skrika Inspektionshandbok Redaktör: Version: 1.1 Datum: Sammanfattning Detta dokument är till för att underlätta arbetet inför och under en inspektion
Projektidentitet Projektgrupp Stum Linköpings tekniska högskola (IDA) Projektmedlemmar Namn Ansvarsområde Telefon E-post Ali Aghajani Projektledare 0730460493 aliag988@student.liu.se Kjell Enblom Dokumentansvarig 076-2353375 kjeen007@student.liu.se Kvalitetsansvarig 076-2311778 filkl784@student.liu.se Johan Millving Designansvarig 0709-788619 johmi359@student.liu.se Andreas Rasmussen Implementationsansvarig 070-3718879 avatar@lysator.liu.se Gustav Veide Systemansvarig 070-5514745 gusve322@student.liu.se Patrik Sandström Kundansvarig 0735464898 patsa014@student.liu.se Thomas Janowski Testansvarig 0709-507595 tomja961@student.liu.se E-postlista för hela gruppen pum1@und.ida.liu.se Hemsida www-und.ida.liu.se/~pum1 Kund Kundkontakt Bertil Lyberg, berly@ida.liu.se Mustapha Skhiri, mussk@ida.liu.se Handledare Sten Sunnergren, sten.sunnergren@ekhosat.se Examinator och kursansvarig Robert Kaminski, IDA
Dokumenthistorik Version Datum Utfärdade ändringar Utfärdade av 0.1 2005-09-05 Dokumentet skapades. 1.0 2005-09-07 Ändringar efter kommentering 1.1 Ändringar efter kommentarer från examinator ii
iii
1 Inspektionshandbok... 1 1.1 Syfte... 1 1.2 Inspektionens olika faser... 1 1.3 Förberedelser... 1 1.3.1 Inspektionsmöte...1 1.3.2 Beslut... 2 1.3.3 Korrigering... 2 1.3.4 Kontroll av korrigering... 2 1.4 Felklassificering... 2 1.4.1 Olika typer av fel... 2 1.4.2 Olika klasser av fel...2 iv
v
1 Inspektionshandbok 1.1 Syfte Inspektionshandbokens syfte är att underlätta arbetet för de projektmedlemmar som skall närvara vid en inspektion av ett dokument. 1.2 Inspektionens olika faser 1. Förberedelser 2. Inspektionsmöte 3. Beslut 4. Korrigering 5. Kontroll av korrigering 1.3 Förberedelser På ett inspektionsmöte finns det tre olika arbetsuppgifter: Moderator: Leder inspektionen (detta kan vara samma person som sekreteraren). Sekreterare: Antecknar alla fel som upptäcks i ett inspektionsprotokoll. Inspektör: Inspekterar dokumentet (skall vara minst två personer). Dessa roller måste tilldelas senast dagen innan inspektionsmötet. Innan inspektionsmötet skall dokumentet kommenteras på egen hand för att upptäcka de flesta av de stora uppenbara felen och även för att bekanta sig med dokumentet. För att denna kommentering skall kunna genomföras måste redaktören av dokumentet se till att den senaste versionen finns tillgänglig senast dagen innan inspektionen. För att kunna kommentera effektivt skall man skriva direkt på en papperskopia av dokumentet och föra kommentarer enligt kvalitetsplanen [Klasson, 2005]. För att inspektionen skall vara så effektiv som möjligt skall man helst aldrig hålla en inspektion i mer än en timmar i streck. Efter en timma skall man ta en paus på 15 minuter. 1.3.1 Inspektionsmöte Moderatorns uppgift är att leda mötet samt att ta med inspektionsprotokoll, projektpärmen samt en ren papperskopia av dokumentet. Sekreteraren antecknar alla fel i inspektionsprotokollet. Mötet skall gå till enligt följande: 1. Moderatorn bestämmer hur stora delar av dokumentet som skall inspekteras åt gången. Redaktören kan gärna skicka med en checklista liknande den som finns i Appendix I i RUT 10.5 [Venuganti, 2003] och markera de punkter som känns viktiga för inspektörerna att undersöka. 2. En inspektör åt gången redogör vilka fel som upptäckts i delen. Kapitel 1: Inspektionshandbok 1
3. De fel som rapporteras antecknas av sekreteraren i inspektionsprotokollet samtidigt som felen markeras i den rena papperskopian av dokumentet. Inspektionsprotokollet som finns i Appendix I i RUT 10.5 [Venuganti, 2003] skall användas. 4. Punkt 1 till 3 upprepas tills den planerade delen av dokumentet inspekterats. 5. Moderatorn skriver ett felstatistikprotokoll. 6. Inspektionsprotokollet, papperskopian med alla antecknade fel lämnas till redaktören eller lämnas i projektskåpet. Det är viktigt att lösningen på fel som hittas ej diskuteras då detta gör att inspektionsmötet tar alldeles för lång tid. 1.3.2 Beslut Efter inspektionen tar deltagarna ett beslut, dessa beslut kan tas: Godkänner dokumentet. Godkänner dokumentet efter ändringar. Delar av dokumentet måste genomgå en ominspektion efter ändringar eftersom de delarna innehöll många fel. Hela dokumentet måste ominspekteras om det visar sig att större delen av dokumentet innehåller för många fel. 1.3.3 Korrigering Redaktören av dokumentet rättar de fel som upptäckts under inspektionen eller förtydligar texten i de delar där inspektionsgruppen missuppfattat något. 1.3.4 Kontroll av korrigering Efter redaktören gjort korrigeringen är det moderatorns uppgift att kontrollera redaktörens nya dokument. Om ett beslut om ominspektion tagits skall moderatorn se till att inspektionsproceduren upprepas. Om det är beslutat att dokumentet skall godkännas efter ändringar skall moderatorn endast kontrollera att redaktören genomfört ändringarna. 1.4 Felklassificering För att få ett tydligt inspektionsprotokoll skall fel antecknas enligt följande. 1.4.1 Olika typer av fel S Språk: stavfel, grammatikfel etc St Struktur: Felaktig struktur på dokumentet så som felaktig styckesindelning etc. I Innehåll: Faktafel, otydligt formulerat etc K Konsistensfel: T ex Motsägelser L Layout: Felaktigt utseende. Ö Övrigt: Övriga fel som inte passar in under någon specifik feltyp. 1.4.2 Olika klasser av fel A Allvarligt fel: Fel som påverkar övriga dokument. S Stort fel: Fel som måste rättas till, samt fel där mycket måste ändras. 2 Kapitel 1: Inspektionshandbok
L Litet fel: Ett fel med litet betydelse där allt fortfarande fungerar som det skall. Exempel stavfel i kvalitetsplanen. P Påpekande: Tveksamheter, t ex att en mening måste omformuleras. Kapitel 1: Inspektionshandbok 3
4 Kapitel 1: Inspektionshandbok