Sadržaj

1 Predmet i područje primene2 Usklađenost3 Veza sa drugim dokumentima4 Termini i definicije5 Upravljanje kvalitetom6 Prilagođavanje7 Ciljevi8 Zahtevi

8.1 Proces dokumentovanja8.1.1 Uvod8.1.2 Obezbeđenje izvornog materijala8.1.3 Dokumentacioni plan8.1.4 Pregled8.1.5 Ispitivanje upotrebljivosti dokumentacije8.1.6 Razvoj dokumentacije poveren drugim preduzećima kao

podugovoračima8.1.7 Promena upravljanje i održavanja dokumentacije

8.2 Specifikacija stila8.2.1 Uvod8.2.2 Stil pisanja8.2.3 Papirna dokumentacija8.2.4 Elektronska dokumentacija

Prilog A (informativan) Međuodnos sa ISO/IEC 12207Prilog B (informativan) Pozivanje na Međunarodni standard iz ugovoraPrilog C (informativan) Primer dokumentacionog plana: ABC sistema za upravljanje

trakamaPrilog D (informativan) Veze između ciljnih grupa, zadataka, papirne i on-line

dokumentacijePrilog E (informativan) Pisanje na engleskom za prevođenjePrilog F (informativan) ProcenaPrilog G (informativan) Procena dokumentacionog planaPrilog H (informativan) Primer specifikacije stilaBibliografijaIndeksSlikeSlika 1 Pregled procesa dokumentovanjaSlika D.1 Hijerarhija ciljne grupeSlika D.2 Hijerarhija zadatakaSlika D.3 Informacione potrebeSlika D.4 Pregled procesaTabeleTabela 1Tabela A.1Tabela C.1Tabela C.2 Projektni timTabela C.3 RasporedTabela F.1Tabela H.1 Elementi stila i vrednosti

1

Informaciona tehnologija-izrada softverske korisničke dokumentacije

Predgovor

ISO (Međunarodna organizacija za standardizaciju) i IEC (Međunarodna elektrotehnička komisija) zajedno formiraju sistem za opštepriznatu standardizaciju kao celinu. Nacionalne institucije, koje su članice ISO i IEC, učestvuju u razvoju međunarodnih standarda kroz rad u tehničkim komitetima koje je ustanovila odgovarajuća organizacija radi obrade posebnih oblasti tehničkih aktivnosti. Tehnički komiteti ISO i IEC sarađuju u poljima od obostranog interesa. Međunarodne organizacije, vladine i nevladine, koje su u vezi sa ISO i IEC, takođe učestvuju u tom radu.Međunarodni standardi se objavljuju prema pravilima koje su date u ISO/IEC uputstvima, Deo 3.

U području informacione tehnologije ISO i IEC su ustanovili združeni tehnički komitet, ISO/IEC JTC 1. Nacrti međunarodnih standarda koje je usvojio združeni tehnički komitet šalju se svim nacionalnim telima na saglasnost pre njihovog usvajanja kao međunarodnih standarda. Standardi se usvajaju prema postupku po kome standard mora da usvoji najmanje 75 % članica.Postoji mogućnost da neki elementi ovog međunarodnog standarda postanu predmet patentnih prava. ISO i IEC neće preuzimati odgovornost za identifikovanje bilo koakvih takvih patentnih prava.Međunarodni standard ISO/IEC 15910 je pripremio združeni Tehnički komitet ISO/IEC JTC 1, Informaciona tehnologija, podkomitet SC7, Softverski inženjering.Prilozi od A do H u ovom međunarodnom standardu su informativni.

2

Uvod

Postoje dva osnovna tipa standarda:

a) standardi proizvoda, koji sodređuju karakteristike i funkcionalne zahteve proizvodab) standardi procesa, koji određuju način na koji proizvodi treba da budu razvijeni

Sve veća primena i kompleksnost kompjuterskog softvera uslovljava nephodnost postojanja kompletne, važeće i razumljive dokumentacije za one koji koriste softver. Međunarodni standardi obezbeđuju alat za postizanje toga, navođenjem onih aktivnosti (šta treba da se uradi i ko treba da uradi) koje mogu uticati na kvalitet softverske korisničke dokumentacije.

Često se smatra da je dokumentacija nešto što treba uraditi nakon što je softver već implementiran. Ipak za kvalitetnu izradu softverske dokumentacije, trebala bi da bude sastavni deo procesa izrade softvera. Ako je urađeno ispravno, to je prilično veliki posao koji zahteva pravi proces planiranja. Namena ovog Međunarodnog standarda je da ohrabri one koji rade na razvoju softvera da daju pravo mesto izradi ove dokumentacije.

Osnovna aktivnost ovog međunarodnog standarda je kreiranje potpunog plana za razvoj dokumentacije. Ovo je neophodno zbog toga što će se ostvariti bolji rezultati ako su planirani. Da bi se pridržavali ovog međunarodnog standarda, plan mora uključivati specifikaciju stila. Ovaj međunarodni standard ne određuje sadržaj specifikacije stila (npr. ne određuje određeni izgled ili tip znakova), ali određuje šta specifikacija stila mora da obuhvata. Ovaj međunarodni standard takođe određuje koje vrste informacija daje naručilac dokumentatoru i ko ocenjuje i reprodukuje dokumentaciju.

Ostale informacije na ovu temu mogu se dobiti kontaktiranjem relevantnih organizacija ili iz literature (videti Bibliografiju)

Ovaj Međunarodni standard je pripremio ISI/IEC JTC SC7, zasnovan na australijskom standardr AS 4258:1994.Za upoređivanje sa ISO/IEC 12207:1995 i ovog Međunarodnog standarda, vidi prilog A.

3

INFORMACIONA TEHNOLOGIJA - IZRADA SOFTVERSKE KORISNIČKE DOKUMENTACIJE

1 Predmet i područje primene

Ovaj međnarodni standard specificira minimum procesa za kreiranje svih oblika korisničke dokumentacije za softver koji ima korisnički interfejs. Ovi oblici dokumentacije uključuju štampanu dokumentaciju (npr. korisničke priručnike i kartice za brzi pristup nepoznatim pojmovima), on-line dokumentaciju, tekstove sa uputstvima i sisteme on-line dokumentacije.

Ovaj međunarodni standard je u skladu sa ISO/IEC 12207:1995, Informaciona tehnologija - Proces životnog ciklusa softvera i predstavlja primenu njegovog dela za korisničku dokumentaciju deo 6.1: Dokumentacija

Ako se efektivno primeni, ovaj međunarodni standard će podržavati razvoj dokumentacije koja ispunjava potrebe korisnika.

Ovaj međunarodni standard je namenjen svima koji proizvode ili kupuju korisničku dokumentaciju.

Ovaj međunarodni standard je namenjen za korišćenje ne samo za štampanu dokumentaciju, nego takođe i za ekrane koji sadrže uputstva i on-line sisteme sa uputstvima. Videti bibliografiju.

Ovaj međunarodni standard je namenjen za upotrebu u situacijama u kojima učestvuju dve strane i može se jednako primeniti u slučaju kada su obe strane iz iste organizacije. Ova slučajevi mogu da variraju od neformalnog dogovora do pravno obavezujućeg ugovora. Ovaj međunarodni standard može koristiti i jedna strana kao sopstvenu obavezu.

Napomena Prilog B obezbeđuje dalje smernice za korišćenje ovog međunarodnog standarda u ugovoru između naručioca i dokumentatora.

2 Usklađenost (Conformance)

Usklađenost ovog međunarodnog standarda je definisana prikazivanjem skupa procesa u tački 8 ovog međunarodnog standarda.

3 Veza sa drugim standardima

Sledeći standardi sadrže odredbe koje, kroz upućivanja u ovom tekstu, čine odredbe ovog standarda. Navedena izdanja važila su u vreme objavljivanja. Kako svi standardi podležu reviziji, učesnici ugovora zasnovanih na ovom standardu pozvani su da ispitaju mogućnost primene najnovijih izdanja niže navedenih standarda. Članice IEC i ISO održavaju registre tekućih važećih međunarodnih standarda.

ISO 216:1975, Pisanje dokumenata i određene vrste štampanog materijala - Prečišćeni tekstovi - A i B serija.

4 Termini i definicije

Za potrebe primenjivanja ovog međunarodnog standarda primenjuju se sledećei termini i definicije:4.1A4, A5Međunarodne veličine papira, A4 je dimenzija 210mm sa 297 mm i A5 dimenzija 148 mm sa 210mm; videti ISO 216:1975

4

4.2nabavljač, naručilac (acquier)organizacija koja pribavlja ili posreduje u nabavci sistema, softverskog proizvoda od isporučioca.ISO/IEC 12207:1995, definicija 3.1

Napomena: Nabavljač može biti kupac, potrošač, vlasnik, korisnik, zakupac. U ovom međunarodnom standardu naručilac je strana koji zahteva dokumentaciju. Napominjemo da naručilac nije neophodno ona strana koja koristi dokumentaciju. Takođe napominjemo da naručilac može pripadati istoj organizaciji kao i dokumentator ili kao projektant softvera.

4.3ciljna grupa (audience)kategorija korisnika koji imaju iste karakteristike i potrebe (npr. namena korišćenja dokumentacije, zadatke, nivo obrazovanja, mogućnosti, obučenost, iskustvo) koji određuju sadržaj, strukturu i korišćenje određene dokumentacijeNapomena: Može postojati veliki broj različitih korisnika softverske dokumentacije (rukovodstvo, operateri, oni koji vrše održavanje)

4.4istraživanje ciljne grupe (audience research)planirani proces intervjuisanja, analiziranje podataka iz intervjua i podataka o osobiNapomena Namena istraživanja ciljne grupe je određivanje mogućnosti, obučenosti, ograničenja, ubeđenja i opredeljenja čitalaca kojima je namenjen dokument.

4.5B5 Međunarodna veličina papira, 176 mm sa 250 mm; videti ISO 216:1975

4.6 back matter materijal koji se pojavljuje na kraju knjige ili priručnika, kao npr. indeks

4.7Spremno za štampu (camera-ready orginals)skup slika na papiru, fotografskom filmu ili nekom drugom pogodanom mediju sa kojeg je moguće direktnim fotografskim transferom dobiti ploču za štampanje a gde svaka slika sadrži sve neophodne tekstualne i grafičke elemente za jednu kompletnu stranicu dokumentacije i gde je svaki element na pravoj poziciji.

4.8datum razgraničenja (cut-off date)datum nakon kojeg se promene na softveru odražavaju u sledećoj verziji dokumentacije.

4.9 Elementi za isporuku (deliverables)elementi čija je isporuka kupcu regulisana ugovorom

4.10dokument (document)ekvivalentno elementu dokumentacije

4.11dokumentacija (documentation)štampani korisnički priručnici, on-line dokumentacija i tekstovi sa uputstvima koji opisuju kako se koristi softverski proizvod

5

4.12osoblje za razvoj dokumentacije (documentation development stuff)svo osoblje koje je uključeno u bilo koju fazu planiranja, pisanja, obrada i izrade dokumentacijeNapomena Ovo uključuje autore, dizajnere, ilustratore i rukovodioce projekta

4.13dokumentacioni plan (documentation plan)dokument koji postavlja osnovne elemente projekta dokumentacije

4.14dokumentator (documenter)strana koja priprema dokumentacijuNapomena Termin projektant (kao što je definisano u ISO/IEC 12207:1995, definicija 3.8) nije korišćena ovde

4.15elektronska kopija (electronic copy)hard disk ili drugi mediju, računarski čitljiv, koji sadrži datoteku ili datoteke a sa kojih dokument može da se odštampa

4.16crtica (en dush)crtica iste širine kao malo slovo "n"

4.17zaključne napomene (endnotes)napomene navedene na kraju poglavlja ili dokumenta

4.18foldoutpojedinačna strana, šira od ostalih, pravilno savijena tako da ne štrči, (viri, ističe se ), tako da je čitalac može raširiti - suprotno od throwclear

4.19Futer (footer)materijal koji se ponavlja na dnu svake strane (npr. broj strane)

4.20fusnota (footnote)tekst na dnu strane, obično ispisan manjim slovima, označen brojem ili nekom drugom oznakom koji upućuje na tekst na istoj strani

4.21front mattermaterija koji se nalazi na početku knjige ili priručnika, kao čto je naslovna strana ili sadržaj

4.22zaglavlje (header)materijal koji se ponavlja na vrhu svake strane

4.23naslov (heading)tekst koji označava temu koja će biti obrađena u nastavku teksta

6

4.24sistem sa uputstvima (help system)videti on-line sistem dokumentacije

4.25 tekst sa uputstvima (help text)tekst kome pristupa korisnik pri korišćenju softvera i koji se automatski izdvaja prema kontekstu u kom je pozvan, tj. tekst za pomoć je kontekst senzitivan

4.26element dokumentacije (item of documentation)informacija određenog formata koja je namenjena određenoj ciljnoj grupi za specifičnu namenu i koja koristi neki od mediju (npr. knjigu, disk, video ...)

4.27upućivanje na poziciju (location reference)pokazatelj sličan indeksu koji odgovara naslovima ili podnaslovima i koji pokazuje na koji deo dokumenta se odnose naslovi ili podnaslovi

4.28redigovanje (mark-up)dokument sa napisanim komentarima koji pokazuju koje promene treba izvršiti; takođe označava i proces izrade takvog dokumenta

4.29tehnička obrada (mechanicals)štampanje, povezivanje, izrada i sređivanje detalja za papirnu dokumentaciju

4.30navigacija (navigation)način na koji se korisnik pomera sa jednog dela softverske aplikacije u drugi

4.31on line dokumentacija (on-line documentation)informacija kojoj pristupa korisnik pri korišćenju softvera koja ne mora da bude kontekst senzitivna - Videti tekst sa uputstvima

4.32sistem on-line dokumentacije ili sistem sa uputstvima (on-line documentation sysytem or help system)pomoćni deo programa ili ponekad zaseban program, koji dozvoljava korisnicima da na zahtev vide delove on-line dokumentacije ili tekst sa uputstvima - Videti takođe on-line dokumentaciju ili tekst sa uputstvima.

4.33orphanzasebna linija teksta na kraju strane, van konteksta

4.34 papirna dokumentacija (paper dokumentation)deo dokumentacije u štampanom obliku

7

4.35piksel (pixel)najmani elemenat na ekranu; skraćeno od "picture element"

4.36 tačka (point)mera vertikalne udaljenost; aproksimativno 1 milimetar je 2,8 tačaka (aproksimativno 72 tačke u inču)

4.37proces (process)skup povezanih aktivnosti koji transformišu ulaze u izlaze

4.38proizvod (product)kompletan skup računarskih programa, procedura i pridružene dokumentacije i podataka namenjen za isporuku korisniku

4.39 izrada (production)koraci koji nacrt teksta pretvaraju u kompletan tekst sa uputstvima ili on-line dokumentaciju u oblik spreman za štampu

4.40Verzija za konačno odobrenje (proof)završna kopija papirne dokumentacije koja se daje na uvid naručiocu radi kontrole pre izdavanja

Napomena Ukoliko se ne zahtevaju izmene, završni dokumenat bi trebalo da izgleda kao verzija za konačnu odobrenje, u svakom pogledu, osim izgledu papira, poveza i boja. Kopije za konačno odobrenje su u načelu fotokopije originala pripremljenih za štampu.

4.41prototip (prototype)model ili preliminarna implementacija dela softvera koji je pogodan za vrednovanje projekta sistema, performansi, potencijala proizvoda ili boljeg razumevanja softvererskih zahteva.

4.42RectoStranica sa iste strane (desno ili levo) kao i naslovna strana

4.43prikaz ekrana (screen dump)prikaz onoga šta će korisnik videti koristeći softver

4.44sistem (system)integrisana celina koja sadrži jedan ili više procesa, hardvera, softvera, opreme i ljudi koji obezbeđuju mogućnost za zadovoljenje navedenih potreba ili ciljeva[ISO/IEC 12207:1995,3.31]

4.45sadržaj (table of contents)spisak naslova u dokumentu u redosledu po brojevima stranica, sa brojem strana navedenim iza svakog naslova

8

4.46spisak važećih stranica (table of effective pages)spisak koji pokazuje poslednju verziju broja svake strane u papirnom dokumentu sa zamenjenim stranama; tamo gde su zamenjene strane, spisak brojeva važećih stranica pokazuje staru verziju za nepromenjene brojeve strane i novu verziju za promenjene strane.

4.47Plan za izbor tima (team selection plan)dokument koji određuje kvalifikacije, iskustvo i potrebe osoblja za razvoj dokumentacije

4.48throwclearpresavijen papir kod kojeg je područje za štampu takvo da sva materija na jednoj strani može da se vidi kad je knjiga sklopljena svo vreme dok se gleda bilo koja prethodna strana knjige

4.49Laboratorja za ispitivanje (usability laboratory)tipično, prostorija za vrednovanje i posmatranje koja može biti opremljena sa audio opremom za snimanje korisnikove reakcije.

4.50Ispitivanje upotrebljivosti (usability testing)formalni proces za vrednovanje upotrebljivosti dokumentacije

4.51korisnički interfejs (user interface)interfejs koji omogućava da informacije budu propuštene od korisnika ka hardverskim i softverskim komponentama računarskog sistema

4.52korisnik (user)pojedinac ili organizacija koja koristi sistem radi izvršavanja specifičnih funkcija

4.53verso stranica sa suprotne strane (desno ili levo) naslovne stranice.

4.54Prazan prostor, aktivan (white space, active)područje oko tekstualnih ili grafičkih elemenata, ne uključujući margine, koje odvaja tekst, grupe tema i podtema, pokazujući hijerarhijske veze, osvetlavajući informacije što olakšava korisniku čitanje.

4.55Prazan prostor, pasivan (white space, passive)gornja, donja, leva i desna margina koja okružuje tekst.

4.56widowlinija teksta na početku strane, van konteksta

9

5 Upravljanje kvalitetom (Quality Management)

Ako je razvoj softvera dokumentovan prema standardu upravljanja kvalitetom, propisi iz standarda se jednako primenjuju na razvoj softvera i na njegovu dokumentaciju.Napomena Čak i kada standard upravljanja kvalitetom nije naveden u ugovoru, dokumentatorima se predlaže da koriste sistem upravljanja kvalitetom koji treba da usklade sa odgovarajućim standardima upravljanja kvalitetom. U vezi sa kvalitetom uopšteno, videti takođe ISO/IEC12119:1994, Informaciona tehnologija - Softverski paket - Zahtevi kvaliteta i testiranje

6 (Prilagođavanje) Tailoring

Ovaj međunarodni standard je jedna implementacija procesa dokumentovanja kako je definisano u ISO/IEC 12207:1995, Infromacione tehnologije - Procesi životnog ciklusa softvera (videti prilog 3)

7 Ciljevi (Objectives)

Ovaj međunarodni standard je u osnovi standard procesa. On ne propisuje bilo kakav format dokumenta, sadržaj dokumenta ili bilo koji drugi aspekt kompletiranja dokumentacije; u stvari, on propisuje način na koji proces dokumentovanja treba planirati i sprovesti.

8 Zahtevi

8.1 Proces dokumentovanja

8.1.1 Uvod

Aktivnosti procesa dokumentovanja treba da se izvršvaju prema redosledu prikazanom na Slici 1, koja ima dva osenčena polja. Sve aktivnosti unutar osenčenih polja treba da se završe pre početka aktivnosti u sledećem osenčenom polju. Aktivnosti unutar jednog osenčenog polja mogu se odvijati paralelno. Isprekidane linije označavaju moguće iteracije.

Dokumentator za vreme razvoja dokumentacionog plana, treba da uzme u obzir minimalni sadržaj dokumentacije, ako je naručilac odredio (npr. za ovu potrebu može biti korišćen ISO 6592 ili ISO 9127:1988)

8.1.2 Nabavka izvornog materijala (provision of source material)

Naručilac obezbeđuje dokumentatoru pristup:

a) svim relevantnim specifikacijama, strukturama podataka, izgledima ekrana i izveštaja, izgledima CASE alata i bilo kojim drugim informacijama potrebnih za pripremu dokumentacije.

b) operativnoj kopiji softvera, ako je dostupna.c) analitičarima i programerima softvera, što podrazumeva pravovremeno i precizno razrešenje

pitanja koja je postavilo osoblje za razvoj dokumentacijed) gde je moguće, tipičnim korisnicima kao ciljnoj grupi za analiziranje i testiranje.

Radi postizanja razumevanja proizvoda i ciljne grupe naručioca, dokumentatorova odgovornost je održavanje pristupa projektantima softvera na neophodnom minimumu.

Napomena: Dokumentator nije odgovoran za razvoj, proveravanje i ispravljanje izvornih informacija, samo za komunikaciju.

10

Bez obzira da li je dokumentator takođe i projektant softvera, naručilac će obezbeđuje kopije svih primenjivih standarda, smernica za stilove i formatiranje i ostalih srodnih materijala (osim opšte dostupnih). Dokumentator distribuira ovaj materijal onim projektantima koji to zahtevaju.

Naručilac je odgovoran da obezbedi da je sav materijal koji isporučuje dokumentatoru kompletan i tačan i da se čuva nakon isporuke do utvrđenog datuma.

Naručilac garantuje da ni jedan materijal ne narušava prava intelektualne svojine ni jedne strane.

Slika 1 - Pregled procesa dokumentovanja

Dokumentator preduzima sve razumnene korake da obezbedi da se materijal koji je obezbedio naručilac korektno čuva, prema zahtevu naručioca obezbeđuje informacije i vraća sav materijal naručiocu radi kompletiranja projektne dokumentacije.Napomena: U nekim slučajevima, nije potrebno da se vrati sav materijal: to treba definisati u ugovoru. U nekim slučajevima zahteva se da materijal koji naručilac daje dokumentatoru bude čuvan kao tajan i siguran. Ugovor treba da specificira nivo tajnosti ili sigurnosti koji naručilac traži od dokumentatora za materijale koje je naručilac dao dokumentatoru.

8.1.3 Dokumentacioni plan (documentation plan)8.1.3.1 Uvod (General)

11

Nabaviti izvorni materijal (Naručilac i dokumentator) član 8.1.2

Izrada dokumentacionog plana (dokumentator) - član 8.1.3

Pregled dokumentacionog plana (naručilac) član 8.1.4.2

Razvoj dokumentacije (dokumentator) - kako je postavljeno u dokumentacionom planu

Umnožavanje i distribucija (dokumentator) kako je postavljeno u dokumentacionom planu -(videti član 8.1.3.1 (f))

Pregled dokumentacije (naručilac) - član 8.1.4.3 do 8.1.4.5

Ispitivanje upotrebljivosti (naručilac i dokumentator) kako je postavljeno u dokumentacionom planu (videti član 8.1.5)

Dokumentator priprema dokumentacioni plan koji specificira aktivnosti u procesu izrade dokumentacije. Dokumentacioni plan formalno odobrava naručilac da on obuhvata njegove zahteve.

Napomena: Dokumentacioni plan generalno opisati celokupnu dokumentacionu garnituru, uključujući npr. korisničke priručnike, on-line dokumentaciju, tekst za pomoć i kartice za brzi pristup nepoznetom pojmovima. Videti prilog C za primer jednostavnog plana. Takođe videti prilog D za opis procesa razvoja.

Dokumentacioni plan formalno opisuje područje primene i ograničenja planirane dokumentacije, kao i važne analize dokumentacije i odluke koje se donose pri izradi dokumentacije. takođe specificira procese i kontrole koje se implementiraju tokom razvoja dokumentacije.

Dokumentacioni plan uključuje, pored ostalog i sledeće:

a) Radni naslov, namenu, područje primene i ograničenja planirane dokumentacije.b) Specifikaciju stila, kako je postavljeno u 8.2 u ovom međunarodnom standardu.c) Definiciju ciljne grupe (videti 8.1.3.2).d) Razloge zbog kojih će dokumentaciju koristiti definisana ciljna grupa i za koju namenu.e) Nacrt sadržaja dokumentacije, sa procenjenim brojem strana i ekvivalentnim detaljima za druge

medije.f) Elementi za isporuku: broj štampanih kopija ili elektronskih kopija koje treba obezbediti, formati

diska i datoteke (uključujući verzije softvera) i gde treba da budu isporučene.g) Vlasništvo autorskih prava i druga vlasnička prava.

Napomena Predmet vlasničkih prava je kompleksan. Svi ugovori za dokumentaciju treba da uključe članove koji se odnose na pravo vlasništvo. To može uključiti prenos budućih autorskih prava nad dokumentacijom od dokumentatora ka naručiocu. Dodela prava je tada delotvornija nego kada je dokumentacija završena.

h) Dozvola za prevod na druge jezike.

Napomena Savet: Videti prilog E za više informacija.

i) Gde je potrebno, nivo sigurnosti ili tajnosti za svaki dokument.j) Procedure i kontrole kojima se upravlja procesom razvoja dokumentacije, uključujući čuvanje,

traženje, rezervne kopije, redosled i osiguranje kvaliteta ako je to zahtevano.k) Metode izrade, alati i verzije alata koje će se koristiti.l) Struktura tima u kojem će raditi osoblje za razvoj dokumentacije; opciono plan za izbor tima

Napomena: Ljudima koji su uključeni u različitim fazama pisanja i izrade dokumentacije potrebne su različite veštine. Možda je piscu potrebno dobro poznavanje načina dokumentovanja sistema i iskustvo u pisanju dokumentacije; uredniku je potrebno iskustvo u uređivanju, a ne poznavanje sistema; umetničkom dizajneru nije potrebno nijedno drugo znanje osim poznavanje dizajnerskih alata.

m) Projektne zavisnosti.n) Potrebni radni sati po čoveku i troškovi (videti prilog F kao uputstvo za vođenje troškova).o) Potrebni projektni resursi uključujući informacije i druge resurse koje će naručilac obezbediti i

kada.p) Metode za dostavljanje informacija dokumentatoru za vreme razvoja softvera o promenama na

softveru.q) Plan upravljanja i održavanja dokumentacije (opciono)r) Plan pregleda posle implementacije (opciono)s) Redosled odgovarajućih etapa, uključujući gde je potrebno

12

1) odobrenje dokumentacionog plana2) priprema, ocenjivanje i ispravka svakog nacrta3) ispitivanje upotrebljivosti4) priprema za štampu5) štampanje, povezivanje i distribucija

Gde je potrebno, svaki od ovih elemenata se ponovlja za svaki deo dokumentacije

Napomena1 Bilo bi korisno uključiti u dokumentacioni plan primere slične dokumentacije koju je izradio dokumentator ili čak primere dokumentacije koju su izradili drugi, radi prikazivanja nameravanog stila ili izgleda ili oboje.

Napomena2 Dokumentacioni plan treba da bude pripremljen i odobren pre početka razvoja dokumentacije radi obezbeđenja saglasnosti svh strana oko prihvatanja ciljeva i metoda koje će se koristiti. Nakon prihvatanja, plan treba distribuirati u što većoj meri; distribucijom treba obuhvatiti svo osoblje za razvoj dokumentacije i možda osoblje naručioca i podugovorače (npr. štampare, slovoslagače, prevodioce)

8.1.3.2 Definicija ciljne grupe (Audience definition)

U dokumentacioni plan treba uključiti definiciju nameravane ciljne grupe(a), definisanje korisnika u tim ciljnim grupama u smislu nivoa obrazovanja, sposobnosti, obučenosti, iskustva i bilo kojih drugih važnih karakteristika bitnih za sadržaj, strukturu i korišćenje dokumentacije.

Postoji veliki broj različitih grupa korisnika i svaka poseduje različite karakteristike i svaka ima različitu svrhu korišćenja dokumentacije. Treba definisati odvojeno svaki tip korisnika, uključujući njihove karakteristike i zadatke koji oni pokušavaju da izvrše pomoću dokumentacije.

Napomena1 Podaci za definisanje ciljne grupe treba da budu dobijeni iz:

a) istraživanja ciljne grupe koje vodi naručilac ili dokumentatorb) definicije koju obezbeđuje naručilacc) definicije ciljne grupe dobijene iz nekog drugog izvora

Napomena 2 Kad god je to moguće, osoblje za dokumentacije treba da obiđe tipične korisnike koji rade u svom radnom okruženju i posmatra njihov rad.

8.1.3.3 Upravljanje dokumentacionim planom (Control of dokumentaton plan)

Nakon formalnog dogovora, dokumentator je odgovoran za upravljanje i distribuciju dokumentacionog plana. Dokumentator čuva spisak po kome se distribuiraju kopije.

Ako su kasnije napravljene izmene na dokumentaciom planu (i prihvaćene od strane dokumentatora i naručioca), dokumentator će osigurati da svi vlasnici kopija budu obavešteni o izmenama.

Napomena Zbog problema koji mogu proisteći postojanjem zastarelih kopija plana, dokumentator treba da zabrani nekontrolisano kopiranje plana i da propiše proceduru za kontrolu svih neažurnih kopija plana.

8.1.4 Pregled (Review)

13

8.1.4.1 Uvod (General)

Pregled treba da obavi naručilac, uključujući rasprave sa dokumentatorom, ako je to neophodno.

Napomena Namena pregleda je osiguravanje da je predati materijal kompletan i korektan i da zadovoljava sve potrebe naručioca kako je definisano ugovorom i dokumentacionim planom.Pregled treba da izvrši kvalifikovana osoba sa strane naručioca koja ima dozvolu da zahteva izmene i koja da odobava sadržaj dokumentacije.

Napomena Naručilac treba da ograniči broj osoba koje vrše pregled na neophodan broj koji će obaviti pregled.

Naručilac obezbeđuje da su sigurnosni i zakonski aspekti dokumentacije korektni pre odobravanja svakog nacrta dokumentacije.

Dokumentator upućuje prateće pismo uz dokumentaciju koja se predaje na pregled, u kojem se navodi namena pregleda dokumentacije i odgovornosti onih koji vrše pregled.

Napomena 1 Kvalitet dokumentacije i uspeh pregleda povećava održavanje dobre komunikacije između naručioca i dokumentatora u toku razvoja. Ovo uključuje neformalne diskusije i obezbeđivanje što je pre moguće primerka preliminarnog materijala naručiocu.

Napomena 2 Možda će biti neophodna izmena ugovora u slučaju da su zahtevane izmene izvan delokruga ugovora i dokumentacionog plana.

Napomena 3 Napominje se da proces pregleda ne oslobađa dokumentatora od njegovih odgovornosti da obezbedi da je dokumentacija važeća i kompletna.

Napomena 4 Neophodno je pre predavanja publikacije za odobrenje, da svi ekranski prikazi treba da budu ponovo urađeni da bi se obeybedilo da su ilustracije važeće. Ovo može biti postignuto korišđenjem softvera posle zamryavanja koda i izradom svih ekranskih prikaza sadržanih u publikaciji.

Napomena 5 Komentari naručioca koji proističu iz pregleda treba da budu u obliku redigovanog nacrta ili pisanih primedbi sa odgovarajućim objašnjenjima. Komentari treba da budu takvi da osoblje za razvoj dokumentacije može impelmentirati zahtevane izmene bez dodatnih objašnjenja.

Napomena 6 U velikim složenim sistemima ili sistemima u razvoju u vreme kad je započelo pisanje dokumentacije, može biti neophodno postojanje više od dva nacrta i verzije za konačno odobrenje. U ovim slučajevima maksimalan broj nacrta treba da se dogovori između naručioca i dokumentatora i da se specificira u dokumentacionom planu.

Napomena 7 Označavanje ispravki (korišćenejm indikatora za ispravke, boje, slova posebnog oblika ili druge metode) je pomoć radi efikasnijeg i efektivnijeg pregleda nacrta. Namena označavanja ispravki je isticanje onih delova publikacije koji zahtevaju pregled. Na ovaj način izbegavaju se situacije gde se zahtevaju višestruki pregledi nacrta i da osobe koje vrše pregled ne prelaze više puta uzaludno preko delova publikacije.Preporučuje se korišćenje alata za upoređivanje dokumentacije radi upoređivanja ispravki gde god je to moguće.

Smernice za korišćenje označavanja ispravki su sledeće:

14

a) Nijedna oznaka ispravki ne sme biti štampana u prvom nacrtu nove publikacijeb) Oznake ispravki treba da se koriste da bi pokazale promene na ispravljenoj publikaciji u odnosu

na original.c) U drugom nacrtu, oznaka ispravke sa brojem '1' treba da se koristi kako bi se označila mesta gde

su se promene desile kao rezultat prvog pregleda nacrtad) U trećem nacrtu, broj '2' se koristi da se prikažu izmenee) Nakon trećeg prihvaćenog nacrta, sve oznake ispravki treba da se uklone pre nego što se

publikacija da na konačano odobrenje

8.1.4.2 Pregled dokumentacionog plana (Documentation plan review)

Namena ovog pregleda je obezbeđenje da dokumentacija definisana dokumentacionim planom, kada bude kompletirana, zadovolji dokumentacione ciljeve naručioca. Kod odobravanja dokumentacionog plana, naručilac odobrava sve karakteristike elemenata isporuke koje su definisane u planu.

Napomena Naručilac bi trebalo da obrati pažnju na strukturu, kompletnost i upotrebljivost dokumentacije, kako je navedeno u sadržaju. Gde je izvodljivo, dokumentacioni plan treba da je ocenjen i odobren pre početka rada na prvom nacrtu. Videti prilog G za pregled dokumentacionog plana.

8.1.4.3 Pregled prvog nacrta (First draft review)

Prvi nacrt treba da sadrži okosnicu dokumentacije koja je opisana u dokumentacionom planu sa sadržajem, prilozima i rečnikom pojmova. Kada se koriste alati za automatsko generisanje indeksa, generisani indeksi treba da upućuju na odgovarajuću lokaciju u tekstu. Pravopis, interpukcija, stil i format se opisuju u dokumentacionom planu.

Prvi nacrt dokumentacije pregleda naručilac. Namena ovog pregleda je provera tehničke ispravnosti i potpunosti dokumentacije kako bi se osiguralo da nacrt ispunjava ciljeve dokumentacionog plana. Pravopis, interpukcija, stil i format treba da budu onakvi kako je to definisano dokumentacionim planom.

Kod odobravanja prvog nacrta, naručilac odobrava tehničku ispravnost, strukturu, jasnost i potpunost dokumentacije, osim kada se zahtevaju izmene.

Napomena 1 Treba da se izvrši uređivanje prvog nacrta pre nego što se isporuči. Postoje dva razloga za to:

a) Osigurava se da onaj koji pregleda nije opterećen ispravljanjem slovnih grešaka i grešaka pri formatiranju

b) Osigurava se da će osoba koja vrši pregled pronaći neke tehničke neispravnosti nastale u procesu uređivanja prvog nacrta

Napomena 2 Nacrt treba da se pregleda u odnosu na ciljeve, definiciju ciljne grupe, sadržaj i druge karakterisitike odobrene u dokumentacionom planu. Pre vraćanja nacrta sa primedbama, naručilac bi treba da bude siguran da nacrt sa svim ispravkama ispunjava dokumentacioni plan.

8.1.4.4 Pregled drugog nacrta (Second draft review)

Drugi nacrt uključuje sve izmene sa kojima se složio naručilac u pregledu prvog nacrta i sadrži listu elemenata za isporuku definisane u dokumentacionom planu, što je moguće bliže konačnom obliku.

Namena ovog pregleda je provera da su primedbe prvog nacrta korektno implementirane.

Kod odobravanja drugog nacrta naručilac odobrava sve aspekte dokumentacije očekujući da fizički izgled nacrta možda neće biti u u istom obliku kako je bio prethodno isporučen.

15

Napomena Pre odobravanja drugog nacrta, naručilac treba da je siguran da nacrt (isključujući primedbe naručioca na nacrt) je spreman za pripremu za verzije za konačno odobrenje.

8.1.4.5 Pregled verzije za konačno odobrenje (Proof Review)

Verzija za konačno odobrenje uključije sve promene sa kojima se složio naručilac prilikom pregleda drugog nacrta.

Namena ovog pregleda je da se proveri da su sve primedbe na drugi nacrt korektno primenjene. Svaka nekorektno implementirana primedba se dostavljena dokumentatoru koji će izmeniti dokumentaciju i vratiti kopije naručiocu sa izmenjenim delovima na dalju ocenu.

Odobravanjem verzije za konačno odobrenje, naručilac prihvata da je dokument spreman za izradu.

8.1.5 Ispitivanje upotrebljivosti dokumentacije (Usability testing of documentation)8.1.5.1 Uvod

Dokumentacioni plan treba da postavi potreban nivo ispitivanja upotrebljivosti.

Minimalno, treba da postoji jedno ispitivanje upotrebljivosti dokumentacije koristeći konačnu verziju softvera.

Napomena 1 Ispitivanje upotrebljivosti treba posmatrati kao dopunu ispitivanju i pregledu. Ispitivanje za vreme razvojnog ciklusa treba da koristi prototip softvera koji dozvoljava kompletnu simulaciju као mogućа konačnа verzijа.

Napomena 2 Nakon specifikacije termina ispitivanja upotrebljivosti trebalo bi u potpunosti definisati standard po kome se vrši pregled.

Napomena 3 Kada je pogodno, dokumentacionim planom treba odrediti okolinu u kojoj se obavlja ispitivanje i koja u potpunosti odražava radno područje krajnjeg korisnika. Treba razmotriti korišćenje laboratorije za ispitivanje. Naručilac može biti odgovoran za izvođenje ispitivanja okoline.

Napomena 4 Ispitivanje upotrebljivosti može da se koristi za merenje upotrebljivosti kako je to definisano u ISO/IEC 12119:1994, Informaciona tehnologija - Softverski paketi - Ispitivanje i zahtevi za kvalitet.

8.1.5.2 Planiranje (Planning)

Termini ispitivanja upotrebljivosti treba da su u potpunosti opisani u dokumentacionom planu, uključujući:

a) tačke u razvojnom ciklusu kad se vrši ispitivanje.b) ciljeve ispitivanja.c) mere koje će se koristiti (vreme odgovora na zadatke).d) okruženje za ispitivanje.e) broj i tip korisnika koji učestvuju.f) proces snimanja rezultata ispitivanja i preporuka.g) proces za osiguranje da će preporuke ispitivanja biti primenjeneh) proces dostavljanja rezultata testa svim relevantnim osobama za razvoj dokumentacije i naručiocu.i) odgovornosti osoba za razvoj dokumentacije za vreme ispitivanja.j) proces određivanja potreba za dalja ispitivanja.

16

Napomena 1 Da bi se izvršilo ispitivanje upotrebljivosti dokumentacije, potrebno je da se ispituju publikacija i softver. Za efektivno ispitivanje upotrebljivosti, ispitivanje treba da obaviti što je ranije moguće, tako da se, ako je to neophodno, mogu izvršiti promene i na softveru i na dokumentaciji.

Napomena 2 U vremenskom planu ispitivanja, treba razmotriti dostupnost izvršnih delova softvera i tip funkcije koju oni obavljaju u planirano vreme.

8.1.5.3 Softver (Software)

Kada se ispitivanje vrši pre nego što je razvoj softvera završen, ispravka može biti urađena u toku korišćenja radnog modela ili prototipa softvera. Ispitivanje koje se vrši posle završetka razvoja softvera koristi konačnu verziju softvera.

8.1.5.4 Tipični korisnici (Typical users)

Naručilac treba da obezbedi ljudstvo koje učestvuje u ispitivanju upotrebljivosti. Ovi ljudi treba da imaju iste karakteristike kao i definisana ciljna grupa. Namenu testa im objašnjava naručilac.

Napomena Gde je to moguće, učesnici će biti izabrani iz ciljne grupe kojoj je namenjen softver.

8.1.6 Razvoj dokumentacije poveren drugim preduzećima kao podugovoračima (Documentation development subcontracted to other companies)

Dokumentator obezbeđuje podugovorne strane u skladu sa ovim Međunarodnim standardom, dokumentacionim planom i ugovorom.

U podugovornoj dokumentaciji, dokumentator preuzima stranu "naručioca" prema ovom Međunarodnom standardu, a podugovorač preuzima stranu "dokumentatora".

Napomena Dokumentator treba da ima dogovor sa podugovoračem koji je specificiran ovom Međunarodnom standardu.

8.1.7 Upravljanje izmenama i održavanje dokumenta (Change control and document maintance)

8.1.7.1 Uvod (General)

Postoje četiri tipa izmena u dokumentacionom planu koje treba razmatriti, prema sledećem:

a) Izmene funkcije tekuće verzije (This-version function changes): Izmene u funkciji softvera koje su napravljene kada je počeo rad na pisanju dokumentacije i koje treba da imaju efekta na dokumentaciju koja se objavljuje.

b) Izmene funkcije na sledećoj verziji (Next-version function changes): Izmene u funkciji softvera koje su napravljene kada je počeo rad na pisanju dokumentacije i koje ne treba da imaju efekta na dokumentaciji koja se objavljuje, nego koje treba da se odraze na sledeća izdanja dokumentacije.

Napomena razlika između tačaka (a) i (b) se obično definiše terminom "datum razgraničenja" (cut-off-date)

c) Izmene nakon publikovanja softvera (Post-publication software changes): Izmene koje su urađene na softveru nakon što je objavljena dokumentacija

d) Izmene nakon publikovanja na dokumentu (Post-publication document changes) Izmene na objavljenom dokumentu koje su nastale bilo zbog izmene softvera ili nakon otkrivanja nedostataka u dokumentaciji

17

8.1.7.2 Postupci (Procedures)

Dokumentator treba da obezbedi da dokumentacija bude napravljena na tako da je moguće uključiti sva četiri tipa izmena. Ovo će zahtevati:

a) postupke za uključivanje svakog od četiri tipa promena u dokumentb) u hederu ili futeru dokumenta pojavljuju se naslov dokumenta i broj verzije ili datum i vremec) za papirnu dokumentaciju sa zamenjivim listovima korišćenje tabele sa važećim stranama ili

slične šeme radi obezbeđenja da korisnik može proveriti da se svaka strana nalazi na odgovarajućem mestu

d) opciono, na neki način osiguranje da sve kopije dokumenta mogu ažurirati nakon izdavanjae) opciono, način na koji korisnik može proveriti da li se kopija dokumenta koju on ima odgovara

verziji softvera koju koristi

Ugovor treba da odredi na šta se odnosi svaki od ovih tipova izmena da bi ih dokumentator uključio u dokumentaciju.

8.2 Specifikacija stila (Content of style specification)

8.2.1 Uopšteno (General)

Ova tačka postavlja sadržaj specifikacije stila.

Napomena Videti prilog H. Specijalizovani standardi i smernice za stil mogu se dodati u specifikaciju stila ili na njih upućivati u dokumentacionom planu.

8.2.2 Stil pisanja (Writing style)

8.2.2.1 Jezik (Language)

Jezik treba da je određen lokalnim specifičnostima, ako je potrebno (npr. Francuski (kanadski)).

8.2.2.2 Pravopis (Spelling)

Za jezike gde je to neophodno, pravopisni rečnik treba da je određen, opciono sa spiskom izuzetaka.

Napomena: Treba odrediti nacionalni standardni rečnik prema nacionalnosti glavne ciljne grupe. Ako je to moguće rečnik treba da bude dostupan kao datoteka za proveru pravopisa.

8.2.2.3 Gramatika i upotreba (Grammer and usage)

Treba odrediti gramatiku i upotrebu stila .

Napomena treba odrediti nacionalnu gramatiku i upotrebu standarda prema nacionalnosti glavne ciljne grupe.

8.2.3 Papirna dokumentacija (Paper documentation)

8.2.3.1 Format i tehnička obrada (Layout and mechanical)8.2.3.1.1 Veličina papira (Paper size)

Treba odrediti veličina papira.

18

Napomena u izboru veličine papira treba uzeti u obzir sledeće:

a) Da su A 4 , B 5 i A 5 međunarodne veličine papira (videti 4. 1 i 4.5).b) Način na koji će dokument biti čuvan (neki sistemi za čuvanje imaju problema sa određenim

veličlinama ).c) Ako se koriste ekranski prikazi (A 5 veličina papira je ćesto vrlo mala da sadrži ekranski prikaz

koji je prevelik da bi bio čitljiv). d) Ako će se dokumentacija fotokopirati, standardna veličina papira se odredjuje prema zemlji u

kojoj če biti korišćena.e) Zahteve za prenosivošću i radnim prostorom.

8.2.3.1.2 Orijentacija (Orientation)

Orijentacija papira se definiše bilo portet ili landscape - drugim rečima uspravno ili položeno. Treba da se odredi orjentacije teksta (odozgo na dole, sa desna na levo,recto ili verso naslovnoj strani) za jezike gde ova opcija postoji.

8.2.3.1.3. Jednostrano ili dvostrano štampanje (Single - or double - sidedprinted)

Treba da se specificira jednostrano ili dvostrano štampanje.

Napomena Radi manje potrošnje papira treba koristiti dvostrani format za štampanje materijala. Jedostrani format se može koristiti za materijale koji će se fotokopirani. Može se razmatrati kada je jednostrana reprodukcija bolji izbor.

8.2.3.1.4 Rezolucija slova ili lasersko štampanje (Resolution of typesetting or laser printing)

Treba da se odredi minimalno prihvatljiva rezolucija u tačkama po inču.

Napomena 300 tačaka po inču se predlože kao minimum.

8.2.3.1.5 Širina unutrašnje margine (margina bliža povezu) (Inside margin width (i.e. margin nearer binding))

Treba da se odredi udaljenost između područja za štampu i ivice poveza.

8.2.3.1.6 Širina vanjske margine (Outside margins width)

Treba da se odredi udaljenost između područja za štampu i ivice papira.

8.2.3.1.7 Boja mastila (Ink colours)

Treba da se odredi boja mastila.

Napomena Ako je u dokumentacionom planu ili u ugovoru navedeno više od jedne boje, svaki dokumentator koji nije stručnjak u području višebojnog štampanja, treba da potraži savet od stručnjaka pre nego što pokaže izgled stranice naručiocu.

8.2.3.1.8 Boja papira, težina i kvalitet (Paper colour, weight and quality)

Treba da se odredi boja papira, težina i kvalitet.

Napomena Treba da se odredi postojanje zalihe papira, ako postoji zahtev.

19

8.2.3.1.9 Razdelinici (Dividers)

Ako se zahtevaju razdelnici, treba da se odredi njihova boja, težina i kvalitet. Specifikacija stila treba da odredi informacije koje treba da se štampaju na razdelnicima, kao i tip znakova, veličinu i orjentaciju.

8.2.3.1.10 Način i kvalitet umnožavanja (Reproduction method and quality)

Treba da se odredi način umnožavanja (štampanje, fotokopiranje, itd), kao i kvalitet umnožavanja.

8.2.3.1.11 Povez (Binding)

Treba da se odredi način povezivanja.

8.2.3.2 Šeme za numerisanje (Numbering schemes)

8.2.3.2.1 Numerisanje strana (Page numbering)

Treba da se odredi šema numerisanja strana.

Napomena 1 Svaka strana treba da bude jedinstveno numerisana. Broj strane treba da na jedinstven način pokaže redosled.

Napomena 2 Ako je povez sa zamenjivim listovima, šema numerisanja je takva da pokazuje oznaku tekućeg poglavlja/sekcije i broj starne unutar tog poglavlja/sekcije, npr "1-1", "1-2", itd. (Ovo je zbog toga da strana može biti dodata u sredinu bez ponovnog numerisanja sledećih stranica.)

Napomena 3 Kada povezivanje nije sa zamenjivim listovima razmatra se korišćenje "1", "2", itd. Često je neophodno iz praktičnih razloga korišćenje različitih šema numerisanja u sadržaju ("i", "ii", itd.). Ipak, treba voditi računa da se ne numerišu back matter (indeks, itd) na isti način kao front matter, zbog toga što bi često došlo do zabune između front i back matter ako, se desi da strane budu zamenjene na odgovarajućoj poziciji.

8.2.3.2.2 Numerisanje ilustracija i tabela (Illustration and table numbering)

Ako ilustracije treba da se numerišu, treba odrediti šemu numerisanja ilustracija. Ako tabele treba da se numerišu, treba odrediti šemu numerisanja tabela.

Napomena Ilustracije i tabele treba jedinstveno numerisati u okviru jedne knjige. Ilustracije i tabele treba da slede redosled u kojem se ilustracije i tabele pojavljuju u knjizi. Može se koristiti numerisanje ilustracija i tabela u jedinstvenom nizu.

8.2.3.2.3 Upotreba fusnota ili zaključnih napomena (Use of footnotes or endnotes)

Treba odrediti upotrebu fusnota i zaključnih napomena.

Napomena Ovo se obično ne koristi u softverskoj korisničkoj dokumentaciji; njihova upotreba ne treba da bude dozvoljena specifikacijom stila.

8.2.3.2.4 Pravila straničenja i dubine (Pagination and gravity rules)

Treba da se odrede pravila straničenja (npr. da se naslovi ne mogu da nalaziti na dnu stranice). Treba da se odrede pravila dubine (regulisanje veličine praznog prostora, widows i orphans)

20

8.2.3.2.5 Front and back matter

Treba da se odrede front i back matter, kad se koriste, kao i njihov sadržaj i fromat:

a) naslovna strana;b) garancija, autorska prava i informacije o trgovačkoj oznacic) sadržaj;d) spisak ilustracija i tabela;e) dodaci;f) rečnik pojmova;g) spisak skraćenica i akronima;h) indeks.

Treba definisati redosled u kojem će se ovi elementi pojavljivati.

Napomena Ako je neophodno odrediti sve gornje tipove front i back matter je potrebno odrediti samo sadržaj i format svakog od tipova.

8.2.3.6 Telo teksta (Body text)8.2.3.6.1 Vrsta slova i veličina (Typeface and size)

Treba odrediti vrstu i veličinu slova u telu teksta.

8.2.3.6.2 Broj kolona (Number of columns)

Treba odrediti broj kolona koji se koristi.

Napomena Najčešće korišćeni format u softverskoj korisničkoj dokumentaciji je sa jednom kolonom, ali takođe se koristi i format sa dve kolone.

8.2.3.6.3 Horizontalni i vertikalni razmak (Horizontal i vertical spacing)

Treba odrediti horizontalni razmak (npr. u romanskim tekstovima razmak sa leve i desne strane paragrafa) i vertikalni razmak (u romanskim tekstovima razmak između linija i pre i posle paragrafa).

Napomena 1 U romanskim jezicima, treba izbegavati format koji ima u telu teksta liniju sa više od 65 karaktera ili manje od 30 karaktera.

Napomena 2 Radi proračuna odgovarajuće dužine linije, prvo postavite dužinu linije od 5 cm i računajte koliko karaktera (uključujući i praznine) ima u deset linija normalnog teksta (ne uključujući prostor između paragrafa) za tu dužinu linije. Podelite sa 50 da biste dobili prosečan broj karaktera po centimetru. Odučite koliko karaktera želite po liniji (treba da bude između 30 i 65) i podelite prosečan broj karaktera po centimetru da biste dobili željenu dužinu linije u centimetrima.

8.2.3.6.4 Poravnanje (Justification)

Treba odrediti poravnanje u telu teksta, gde je to pogodno prema jeziku (npr poravnato sa leva ili poravnato sa obe strane).

8.2.3.7 Naslovi (Headings)

8.2.3.7.1 Broj i nazivi nivoa naslova (Number and names of heading levels)

Treba odrediti broj nivoa naslova i svakom nivou naslova treba dati naziv i broj.

21

Napomena Treba izbegavati sve što je više od tri novoa naslova untar jedne knjige. Tri nivoa naslova su obično dovoljna.

8.2.3.7.2 Stil teksta u naslovima (Text style of headings)

U jezicima gde je to prihvatljivo, treba odrediti stil teksta u naslovu (npr. "rečenički stil", "sva slova").

8.2.3.7.3 Vrsta slova, veličina i razmak u svakom nivou naslovu (Typeface, size and spacing of each heading level)

Treba specificirati vrstu slova, veličinu i horizontalni i vertikalni razmak za svaki nivo naslova.

8.2.3.7.4 Grafički elementi koji se koriste u naslovima (Graphic elements used in headings)

Treba odrediti upotrebu grafičkih elemenata za svaki nivo naslova (npr. linije, boju, ikone)

8.2.3.8 Headers and footers

8.2.3.8.1 Sadržaj hedera i futera (Content of headers and footers)

Treba odrediti sadržaj hedera i futera.

Napomena Ovo je zbog toga što, npr. broj stranice treba da bude najbliži spoljnjoj ivici svake strane

8.2.3.8.2 Korišćeni grafički elementi (Graphics elements used)

Treba odrediti grafičke lemente koji će se koristiti u hederima i futerima (npr. linije, boje, ikone).

8.2.3.9 Podnaslovi (Captions)

8.2.3.9.1 Sadržaj (Content)

Treba odrediti sadržaj podnaslova.

8.2.3.9.2 Vrsta slova, veličina i pozicija (Typeface, size and position)

Treba odrediti vrstu slova, veličinu i poziciju podnaslova.

8.2.3.10 Tabele (Tables)

8.2.3.10.1 Pravila za formatiranje (Layout rules)

Treba odrediti pravila za formatiranje tabela, npr. zaglavlje tabele treba da se ponovlja na narednoj strani, ako je tabela podeljenja na dve strane.

8.2.3.10.2 Vrsta i minimalna veličina slova (typeface and minimum size)

Treba odrediti vrstu i minimalnu veličinu slova koja će se koristiti u tabelama.

22

8.2.3.11 Izveštaji (Reports)

8.2.3.11.1 Uvod (General)

Izveštaji su izlaz iz softverske aplikacije koji se obično štampa ili prikazuje na ekranu. Primeri izveštaja se obično uključuju u korisničku dokumentaciju.

8.2.3.11.2 Sadržaj (Content)

Mogu biti određena pravila izrade sadržaja za izveštaje.

Napomena Izveštaje je lakše razumeti kada prikazuju realne podatke u svakom polju. Ne treba koristiti proizvoljene podatke.

8.2.3.11.3 Vrsta i minimalna veličina slova (Typeface and minimum size)

Treba odrediti vrstu i minimalnu veličinu slova izveštaja.

8.2.3.11.4 Korišćenje položenog formata papira i foldout-a (Use of landscape layout and foldouts)

Treba odrediti pravila za korišćenje položenog formata papira za šire ili duže izveštaje. Treba odrediti pravila za korišćenje foldouts i throwclears

8.2.3.12 Prikazi ekrana (Screen dumps)

8.2.3.12.1 Sadržaj (Content)

Treba odrediti pravila za izradu sadržaja prikaza ekrana.

Napomena Prikazi ekrana su lakše razumljivi ako prikazuju stvarne podatke u svakom polju. Ne treba koristiti proizvoljne podatke.

8.2.3.12.2 Format (Layout)

Treba odrediti pravila za formatiranje prikaza ekrana.

8.2.3.12.3 Pravila formatiranja za delimične prikaze ekrana

Ako su dozvoljeni, treba odrediti pravila za formatiranje delimičnih prikaza ekrana.

8.2.3.13 Ilustracije (Ilustrations)

8.2.3.13.1 Minimalna širina linije, vrsta i veličina slova (Minimum line width, typeface and tzpe size)

Treba odrediti minimalnu širinu linije, vrstu i veličinu slova za ilustracije.

8.2.3.13.2 Orjentacija (Orientation)

Treba odrediti pravila za određivanje orjentacije ilustracije.

8.2.3.14 Upozorenja i opomene (Warnings and cautions)

8.2.3.14.1 Stil teksta (Text style)

23

Za jezike gde je to pogodno treba odrediti stil teksta (npr. "rečenički stil", "sva slova").

8.2.3.14.2 Razmak, vrsta i veličina slova (Typeface, size and spacing)

Treba odrediti razmak, vrstu i veličinu slova za upozorenja i opomene.

8.2.3.14.3 Grafički elementi (Graphic elements)

Treba odrediti grafičke elemente koji će se koristiti u upozorenjima i opomenama (npr. linije, boje, ikone).

8.2.4 Elektronska dokumentacija (Electronic documentation)

8.2.4.1 Tipovi pomoćnih informacija (Type of help information)

Specifikacija stila može sadržati jednu ili više sledećih informacija:

a) Objašnejnje konteksta: Informacije o polju na kom se nalazi kursor, uključujući zahtevani ili nameravani sadržaj i eventalne efekte i odredišta informacija koje su sadržane na njemu.

b) Proširena pomoć: Informacije o tekućem ekranu ili prozoru, uključujući njegovu namenu ili nameravani način rada.

c) Taster za korišenje pomoći: Informacije o korišćenju tastature, sređene po funkciji, a ne po nazivu tastera.

d) Pomoć za pomoć: Informacija o korišćenju sistema pomoći.e) Pomoćne poruke: Šta korisnik treba ili može da radi nakon odgovora na odgovarajuću sistemsku

poruku, kao što je poruka o greški.f) Objašnjenje fraza: Definicija specificiranog elementa, veza ka povezanim temama ili objašnjenja

skraćenica i akronimag) Inteligentna pomoć: Tekst sa uputstvma koji se pojavljuje kada je sistemu očigledno da je korisnik

ima problema. Tekst sa uputstvima može npr. da bude struktuiran tako da inicijalno korisnik dobije kratku poruku sa uputstvom, a dobija više detalja kada ponovi istu grešku, alternativno, korisnik dobija detaljnu informaciju kad prvi put napravi greškum a zatim kratko podsećanje na događaje koji slede.

8.2.4.2 Tipovi on-line dokumentacije (Types of on-line documentation)

Specifikacija stila može sadržati jedan ili više sledećih tipova on-line dokumentacije:

a) Uputstvo za korisnika ili preporuke: Obezbeđuju postupke za korišćenje proizvoda.b) Preporučene komande: (samo sistemi koje pokreću komande) Daju sintaksu, efekte i namenu

korišćenja svake komande.c) Referentne poruke: Šta korisnik treba ili može da radi kada odgovori na određenu poruku, kao što

je poruka o greški.d) Informacija za administratora: Konfiguracija, sigurnost i (ako je to pogodno) informacije o

instalaciji koje zahteva sistem administrator.

8.2.4.3 Format (Layout)

8.2.4.3.1 Uvod (General)

Alati koji se koriste za izradu uputstava i on-line dokumentacije diktiraju mnoge aspekte koji se odnose na format.

24

8.2.4.3.2 Srodne materije (Related materials)

Treba odrediti pravila o postavljanju materija koji su srodne.

8.2.4.3.3 Naglašavanje i upotreba boja (Highlighting and use of colour)

Treba odrediti pravila o upotrebi naglašavanja i boja.

Napomena 1 Korišćenje naglašavanja i boja za isticanje treba svesti na minimum, pogotovo gde postoji rizik oko zbunjivanja između istaknutog teksta i hipertekst veze.

Napomena 2 Boje treba koristiti oprezno i ne treba se oslanjati da je to jedino bitno za dobijanje značajnih informacija. Ovo je naročito bitno kada korisnici mogu da biraju između ekranskih boja.

Napomena 3 Kada se koriste osnovne boje (crvena, zelena i plava) treba koristiti belu ili crnu pozadinu radi postizanja jasnoće i izbegavanja problema pri unosu.

Napomena 4 Različite zasićene boje ne treba koristiti jednu pored druge na tamnoj pozadini, što često rezultuje zbunjujućim trodimenzionalnim efektom

Napomena 5 Izvesne boje su povezane sa uobičajenim značenjem (npr. crveno za "stop" ili "opasnost", zeleno za "idi" ili "bezbedno") i mogu biti izabrane na osnovu toga. Ova vrsta kodiranja treba da se koristi sa oprezom u slučaju gde korisnici mogu da izaberu različite ekranske boje.

Napomena 6 Boje na ekranu su kompleksna oblast i vrlo su često tema oskudnog dizajna. Dokumentatori se savetuju da potraze stručnog asistenta u izboru i korišćenju boja.

8.2.4.3.4 Format on-line dokumentacije i teksta sa uputstvima

Treba odrediti pravila ta formatiranje teksta.

8.2.4.3.5 Naslovi (Headings)

Treba odrediti pravila za formatiranje naslova.

8.2.4.3.6 Telo teksta (Body text)

Treba odrediti sledeće elemente za telo teksta:

a) poravnanje (gde je to pogodno za jezik)b) razmak

Napomena U romanskim jezicima treba izbegavati liniju dužu od 65 i manju od 30 karaktera. Prored između linija teksta treba da bude minimalno širine dva piksela ili crtice široke 15% visine karaktera, zavisno šta je veće.

c) Minimalna visina karaktera

Napomena Za romanske jezike, visina karaktera ne treba da je manja od 16 minuta luka i veća od 45 minuta luka. Preporučena visina karaktera je između 20 i 22 minuta luka. Minute luka se koriste kao mera visine karaktera za VDU karaktere; to je ugao koji se zatvara na oku karakterom. Zavisi ne samo od stvarne visine karaktera na ekranu, nego i od tipično vidljive udaljenosti. Tabela 1 pokazuje vezu između visine karaktera u minutama ugla i milimetara sa vidljive udaljenosti od jednog metra. Na manjoj

25

udaljenosti, na primer, visina u milimetrima će biti proporcionalno manja nego u što je dato u tabeli. Takođe, u tabeli su date, radi poređenja ekvivalentne veličine štampane tačke za Times Roman.

Tabela 1 Ugao zatvaranja i veličina tačke

Ugao zatvaranja u minutima ugla

VisinaMm

Aproksimativna veličina tačke

point10 2,9 1215 4,4 1820 5,8 2425 7,3 3030 8,8 3635 10,2 4240 11,6 4845 13,1 5450 14,6 60

8.2.4.3.7 Navigacija (Navigation)

Treba odrediti pravila za navigaciju.

Napomena 1 Redosled povezivanja treba da je kontrolisan tako da korisnik može jednostavno da se vrati u datu tačku ili u sadržaj ili indeks, bez osećaja izgubljenosti u dokumentu.

Napomena 2 Strukturalna pravila za dokument treba da su projektovana i primenjena konzistentno. Na primer, broj linkova u svakom informacijskom lancu treba da bude ograničen na X, vrednost X je takva da korisnik ima česte i regularne mogučnosti za povratak u sadržaj i da se preorjentiše u dokumentu. Nivoi poglavlja mogu biti pridruženi nivoima kompleksnosti (npr. poglavlje Nivo 1 daje samo opšti pregled)

Napomena 3 Konceptualne informacije i informacije orjentisane ka zadacima treba da su razdvojene u posebne sekcije sa vezama između njih. Ovo će sprečiti korisnike koji pokušavaju da uče određeni zadatak od nesvesnog tumaranja po celokupnoj materiji, koja može da ih zbuni i poremeti.

Napomena 4 Grafiku treba podrazumevati. Dijagrami sa opštim pregledom, koji pokazuju glavne odeljke dokumenta sa hipertekst linkovima ka svakom odeljku, daće korisniku jasnu vizuelnu impresiju strukture dokumenta.

Napomena 5 Odeljak za navođenje korisnika treba da bude obezbeđen na početku dokumenta, dajući osnovne informacije o načinu kako se koristi on-line dokumentacija. Ovaj odeljak treba da se iskoristi za objašnjenje strukture dokumenta i svakog strukturnog pravila koje je primenjeno.

8.2.4.3.8 Korišćenje tastature (Keyboard usage)

Treba odrediti pravila za korišćenje specijalnih tastera za on-line dokumentaciju.

Napomena 1 Korisnik treba da je u mogućnosti da pozove pomoć korišćenjem istog tastera ili kombinacije tastera iz bilo koje tačke programa. Korisnik takođe treba da ima mogućnosti da pozove on-line dokumentaciju korišćenjem nekog tastera ili kombinacije tastera.

Napomena 2 Dokumentacioni plan treba da definiše konvenciju za imenovanje i funkcija svih specijalnih funkcijskih tastera za korišćenje u on-line dokumentaciji ili sistemu sa uputstvima.

Napomena 3 Korišćenje specijalnih funkcijskih tastera u softverskoj aplikaciji treba u svakom mogućem slučaju da bude konzistentno.

26

Prilog A(informativan)

Međusobni odnos sa ISO/IEC 12207

Ovaj Međunarodni standard odgovara ISO/IEC 12207:1995, Informaciona tehnologija - Procesi živitnog ciklusa softvera implementacija korisničke dokumentacije deo6.1: Dokumentacija, kako je prikazano u tabeli A.1.

Tabela A.1 - Međusobni odnos sa ISO/IEC 12207

Član/podčlan ISO/IEC 12207

Član/podčlan ovog Međunarodnog standarda

6.1.1.1 8.1.3 Dokumentacioni plan6.1.2.1 8.2 Secifikacije stila6.1.2.2 8.1.2 Obezbeđenje izvornog materijala6.1.2.3 8.1.4 Pregled6.1.3.1 8.2 Sadržaj specifikacije stila i 8.1.3 Dokumentacioni plan6.1.3.2 8.1.3.3 Upravljanje dokumentacionim planom6.1.4.1 8.1.7 Promena upravljanja i održavanje dokumenta

27

Prilog B(informativan)

Pozivanje na Međunarodni standard u ugovoru (Calling the International Standard from a contract)

B.1 Uvod(General)

Postoje delovi ovog Međunarodnog standarda koji zahtevaju pojašnjenje u vezi sa ugovorom ili drugim (npr. internim) dokumentima u kojima se navodi.

U prilog tome, dokumentacioni plan se često poziva na pojašnjenja.

Pitanja na koja bi trebalo odgovoriti ugovorom su sledeća:

a) Odakle dolaze informacije o istraživanju ciljne grupe? (Navođenje ovog je opciono, ali se savetuje).

b) Da li se zahteva više od dve kopije nacrta i jedne kopije verzije za konačno odobrenje? (Ovo je opiciono: Ovaj Međunarodni standard preporučuje do dva nacrta i jednu verziju za konačno odobrenje).

c) Ko će obezbediti izvorni materijal? (Obično je ovo očigledno, ali u projektima sa kompleksnim međuzavisnostima između delova je bolje ovo razrešiti.

d) Koji nivo tajnosti i sigurnosti je potrebno da primeni dokumentator za materijale koje je obezbedio naručilac?

e) Da li postoji papirna dokumentacija za standardni format koji bi trebalo koristiti? (Opciono ako se drugačije ne odredi. Specifikacija stila definisana u ovom Međunarodnom standardu može se koristiti kao pretpostavka; dokumentacionim planom može se kasnije odrediti broj kopija itd.)

B.2 Primer člana ugovora (Sample contract clause)

PrimerČlan 123 dokumentacije

Sva korisnička dokumentacija treba da je u skladu sa ISO/IEC 15910. Dokumenatcija neće uključivati on-line materijal ili tekst sa uputstvima. Sva istraživanje ciljne grupe i ostale izvornie materijale obezbediće naručilac.

Jedno ispitivanje upotrebljivosti će biti obavljno kod isporuke prvog modula i sadržavaće probu celokupne funkcionalnosti modula korišćenjem pet različitih tipova korisnika.

B.3 Prilagođavanje Međunarodnom standardu (Tailoring the International Standard)

U interesu je i kupca i dokumentatora prilagođavanje Međunaroodnom standardu, ako se to zahteva. Prilagođavanje normalno preuzima formu izbacivanja ili ubacivanja članova koji podrazumevaju pisanu saglasnost (obično ugovor, ali moguće takođe i dokumentacioni plan).

Prilagođavanje međunarodnom standardu treba da se uradi pažljivo i sa poznavanjem strukture Međunarodnog standarda.

28

Prilog C(informativan)

Primer dokumentacionog plana: Korisnička dokumentacija za ABC sistem upravljanja trakama

C.1 Uvod (Introduction)

Ovaj dokument opisuje strategiju razvoja korisničke dokumentacije za ABC sistem upravljanja trakama, kao što je predloženo XYZ dokumentacijom (XYZ). On opisuje predmet i područje primene projekta, isporučioce i zahtevane resurse.

Strategija obezbeđuje kopiju dokumentacije na hard disku i on-line dokumentaciju u formi teksta sa uputstvima.

U slučaju velikih izmena predložene strategije, biće izvršena revizija plana.

C.2 Predmet i područje primene i ograničenja (Scope and limitations)

Dokumentacija neće uključivati instrukcije za korišćenje operativnog sistema koji koristi ABC. Ipak, gde je to pogodno, korisnik će se upućivati na odgovarajuće priručnike za sledeće informacije.

Instalacija ABC-a, implementacija i upravljanje dokumentacijom već postoji i nije predmet ovog projekta.

C.3 Format i stil pisanja (Layout and writing style)

Koristiće se podrazumevani format i stil pisanja koji je specificiran u ISO/IEC 15910. Primer stranice je pridružen dokumentacionom planu.

Uputstvo za stil on - line dokumentacije je prikazan u Tabeli C.1

Tabela C.1 Uputstvo za stil

Element VrednostSadržaj teksta sa uputstvima Jedino treba da bude obezbeđena kontekstna

pomoćSadržaj on-line dokumentacije Ne postojiSrodna materija Tekst sa uputstvima treba da bude ograničen na

jedan ekran po ulazuNaglašavanje i korišćenje boja Boje i ostala naglašavanja ne teba da se koriste u

tekstu za pomoćFormat on-line dokumentacije i teksta sa uputstvima

Treba koristiti format sa jednom kolonom

Format on-line dokumentacije i format naslova teksta sa uputstvima

Treba koristiti samo jedan naslov - na vrhu svake strane teksta sa uputstvima. Naslov treba da bude 14pt Times Roman

Format tela teksta Tekst treba da bude poravnat sa leve strane, a neravan sa desne. Tekst treba da bude pisan korišćenjem nekog sistemskog fonta.

Pravila za navigaciju Kao za ABC sistem za pomoćKorišćenje tastature Kao za ABC standarde

29

C.4 Ciljna grupa (Audience)

Ciljna grupa će se sastojati od operatera na računaru sa niskim nivoom tehničkog znanja. Minimalni nivo obrazovanja ciljne grupe je 12 godina škole.

Niko iz ciljne grupe ne treba da ima poteškoće u čitanju i za sve se pretpostavlja da imaju dobru veštinu čitanja.

Moguće je da ciljna grupa ima jednu do dve godine iskustva u radu u računarskom centru, što uključuje operativne postupke za uključivanje i isključivanje, arhiviranje i oporavljanje sistema, kao i punjenje i pražnjenje traka. Dužnosti takođe uključuju nadgledanje konzole i reagovanje na poruke koje se odnose na rad sistema.

Pretpostavke o korisnikovom znanju su sledeće:

a) Korisnik razume osnovne postupke za održavanje.b) Korisnik razume komande koje se odnose na operativni sistem.c) Korisnik ne razume postupke za održavanje traka koje koristi ABC.

C.5 Nacrt sadržaja (Draft table of contents)

Nacrt sadržaja treba da sadrži sledeće:

a) Uvod: koncepti ABC-a i njegova veza sa sistemom (5 strana)b) Opšti pregled: opšti pregled funkcija ABC sistema za upravljanje trakama (3 strane)c) Dodavanje trake (5 strana)d) Skidanje trake trake (5 strana)e) Problemi: uputstvo u slučaju kvara, uključujući sistemske poruke (4 strane)f) Rečnik termina i definicija (1 strana)g) Indeks (1 strana)

Ukupno: 24 strane.

C.6 Elementi za isporuku (Deliverables)

Sledeći elementi će se isporučiti na kraju projekta:

a) 500 kopija priručnika, povezanob) Kopija na disketi 1,44 Mb, 3,5" , celokupne dokumentacije u formatu DEF 3.0 (podešeno za GHI

štampač)c) Kopija na disketi tekst sa uputstvima

C.7 Autorska prava (Copyright)

Autorska prava svih materijala ostaju u vlasništvu XYZ.

C.8 Prevod (Translation)

Ne postoji ni jedna odredba za prevod.

C.9 Razvojni proces i upravljanje

ABC korisničko uputstvo se kreira korišćenjem razvojnih postupakaa i kontrola koje su specificirane u priručniku XYZ Upravljanje kvalitetom.

30

C.10 Izrada (Production)

Za izradu korisničkog uputstva ABC koristiće se DEF sistem za publikovanje (verzija 3.0). Dijagrami će se kreirati korišćenjem JKL grafičkog paketa.

ABC ekranski prikazi će biti elektronski obrađeni i uključeni u glavni dokument.

Sadržaj i indeks će biti podešeni i generisani korišćenjem DEF.

Master kopija spremna za umnožavanje biće odštampana na laserskom štampaču u rezoluciji 300dpi.; međutim, master se može odštampati u rezoluciji 1275 dpi uz dodatne troškove.Svaki priručnik će biti u formatu A4, sa zamenjivim listovima, dvostrano odštampan i ukoričen.

Povez će biti A4, 3D prsten sa 25 mm spiralom. Korice će biti odštampane u sito-štampi sa ABC korporacijskim dizajnom.

Papir za priručnike je 103 gsm, MNO art i mat.

Tekst sa uputstvima će biti razvijen korišćenjem DEF alata za razvoj.

C.11 Projektni tim (Project team)

Odgovornosti projektnog tima je prikazana u tabeli C.2.

Tabela C.2 Projektni tim

Ime Uloga OdgovornostP O'Brein Pisac Plan istraživanja i pisanje priručnikaA Costa Urednik Uređivanje priručnikaR Richards Tehnički pregled Odobravanje tehničkog sadržaja priručnikaE Johns Tehnički savetnik Obezbeđivanje tehničkih saveta i uputstavaS Wong Izrada Kreiranje teksta i dijagramaA Kellu Upravljanje kvalitetom Upravljanje kvalitetomM Downes Ispitivanje upotrebljivosti Testiranje kompletnog priručniak pod specijalnim

uslovima i izveštavanje o rezultatima

C.12 Izvori (Resources)

Informacije koje se zahtevaju za izradu priručnika će se obezbediti ABC razvojna dokumentacija, intervjui sa projektantima softvera i samostalno korišćenja ABC.

Sledeći izvori se zahtevaju od tima za razvoj dokumentacije:

a) Kopije funkcionalnog razvoja dokumentacije ABCb) Pristup sistemu ABCc) Pristup projektantima softvera ABC

C.13 Ispitivanje upotrebljivosti (Usability test)

Izvršiće se serija ispitivanja upotrebljivosti ABC korisničkog uputstva i tekstu sa uputstvima nakon implementiranih primedbi na drugi nacrt.

Zadatak je ocenjivanje stepena u kojem jezik, sadržaj i format ABC korisničkog uputstva i teksta sa uputstvima omogućavaju korisnicima pristup karakteristikama softvera.

31

Ispitivanje će se vršiti u računarskoj sobi i koristiće se beta test verzija ABC;biće prisutni jedan predstavnik iz tima projektanata softvera i jedan predstavnik iz tima za razvoj dokumentaciije dokumentacije.

Četiri korisnika, kako je rečeno u C.4, će biti nasumice izabrana iz noćne smene. Svakom će biti data kopija korigovanog drugog nacrta ABC korisničkog uputstva i teksta sa uputstvima i biće zamoljeni da izvršavaju seriju koraka (popisanu , gde drugo, nego u detaljnom planu ispitivanja).

Oba predstavnika će zapisivati vreme potrebno za svaki korak, komentare korisnika i fizički proces kroz koji korisnik prolazi izvršavajući korake.

Gde vreme potrebno za izvršenje koraka prekoračuje vreme postavljeno u detaljnom planu ispitivanja za bilo kog od korisnika ili gde koraci nisu zavrđeni na ispravan način, predstavnici projektanata softverskog tima i tima za razvoj dokumentacije će zapisati njegovo ili njeno viđenje razloga za taj problem.

Ove beleške se prikazuju na sastanku za pregled dokumentacije i prema njima će se izmeniti nacrt. Na sastanaku će odlučiti da li postoji potreba za daljim testiranjem.

C.14 Vremenski plan (Schedule)

Vremenski plan je prikazan u Tabeli C.3.

Tabela C.3 - Raspored

Faza Datum ZavisnostIsporuka prvog nacrta 1 Jan 99 Odobravanje dokumentacije 15 Dec 98Isporuka drugog nacrta 15 Feb 99 Tri nedelje pregleda prvog nacrtaIspitivanje upotrebljivosti 15 Mar 99Isporuka teksta sa uputstvima 15 Apr 99 Ispitivanje upotrebljivostiIsporuka verzije ze konačno odobrenje

15 Apr 99 Ispitivanje upotrebljivosti; dve nedelje pregled drugog nacrta

Spremno za štampu -- 30 Apr 99 Ispitivanje upotrebljivostiZavršetak štampanja i koričenje 15 May 99 Raspoloživost osobe koja treba da izvrši povez

32

Prilog D(informativan)

Veza između ciljnih grupa, zadataka, papirne i on-line dokumentacije

Izrada dokumentacije počinje analizom korisnika sistema zbog kojih se radi dokumentacija. Često postoje različiti tipovi korisnika, koji su grupisani u ciljne grupe prema svojim potrebama.

Ponekad je hijerarhija ciljnih grupa najbolji način za predstavljanje različitih grupa, kako je to prikazano na slici D.1.

Slika D.1 - Hijerarhije ciljne grupe

Često je neophodno poboljšati gradaciju jedne ciljne grupe prema iskustvu korisnika u toj ciljnoj grupi pri korišćenju sistema. Na primer, ciljne grupe mogu biti definisane kao "Novi korisnik" ili "korisnik sa iskustvom".Postoji lista ciljne grupe za određeni sistem, sledeći korak je određivanje zadataka koje će svaka ciljna grupa izvršavati. Opet, ovo se često prikazuje kao hijerarhija, kao na slici D.2

Slika D.2 Hijerarhija zadatakaSledeća faza je određivanje, za svaku ciljnu grupu i zadatak informacija koje su potrebne. Spisak potrebnih informacija formira osnovu sadržaja dokumenta, kako je to prikazano na slici D3.

33

Osoblje za unos podataka

Kancelarijsko osoblje

Osoblje za instaliranje

Operatori za unos podataka

Kontrolori unosa podataka

Rukovodioci odeljenja

Osoblje za prodaju na daljinu

Unos narudžbina

Podešavanje obrade narudžbina

Unos pojedinačne narudžbe

Zatvaranje obrade narudžbina

Unos računa

Podešavanje obrade računa

Unos pojedinačnog računa

Zatvaranje obrade računa

Hijerarhija zadataka za ciljnu grupu "operateri za unos"

Slika D.3 - Potrebne informacije

U ovoj fazi (ali generalno ne ranije), određuju se mediji na kojem se vrši isporuka, kao i tip dokumenta.Na primer, za određenu informaciju koja je potrebna datoj ciljnoj grupi i za zadatak, najpodesniji format dokumenta može biti štampani priručnik ili on-line priručnik ili ekran za pomoć osetljiv na kontekst ili poster ili čak video ili kartice za brzi pristup.

Prirodno, ograničavanje broja različitih dokumenata koje treba projektovati ima dobru ekonomsku opravdanost. Često je neophodno napraviti jedan dokumenat koji služi za više namena.Slika D.4 pokazuje kako se izvršava proces od sa jednog kraja na drugi. Suština je saznanje da se korisnička dokumentacija može nalaziti na različitim medijima. Ne postoji unapred definisana uloga za on-line ili papirnu dokumentaciju - uloga određenog medija je da zadovolji korisnikove potrebe, zavisno od date ciljne grupe, proizvoda i skupa zadataka. Planiranje dokumentacije (kao što je navedeno u ovom Međunarodnom standardu) odnosi se uglavnom na određivanje potrebnog znanja i na kraju procesa dolaze na red pitanja o mediju. Tako papirna i on-line dokumentacija treba da se planiraju zajedno zbog toga što mogu biti potrebni istom korisniku radi zadovoljenja potreba za znanjem.

Slika D.4 Pregled procesa

Opis ovog procesa je detaljno dat u Britanskom standardu BS 7649:1993, Uputstvo za izradu i pripremu dokumentacije za korisnike aplikativnog softvera.

Prilog E(informativan)

Pisanje na engleskom za prevođenje (Writing in English for translating)

34

Potrebne informacije za ciljnu grupu "Operatori" za "Podešavanje serijske obrade"

- Korišćenje tastature- Kako se prijaviti- Koji se ekran koristi za podešavanje- Kako kompletirati ekran-

Ciljna grupa

Spisak ciljnih grupa

Spisak zadataka za svaku ciljnu grupu

Zadaci

Potrebno znanje za svaki zadatak za svaku ciljnu grupu

Znanje

Papirni priručnik kartice za brzi pristup

on-line pomoć

Korisnik

Izbor odgovarajućeg medija i tipa dokumenta

E.1 Uvod (General)

Smernice u ovom prilogu treba slediti kada se piše materijal na engleskom jeziku koji se obično prevodi. Većina tačaka se odnosi na papirnu i on-line dokumentaciju.

E.2 Terminologija (Terminology)

Terminologija treba da je kao što sledi:

a) Treba koristiti opšte, a ne tehničke termnine, onako kako su definisani u opštim rečnicima;b) Treba kreirati rečnik pojmova tako da uključuju:

1) definicije svih specifičnih i nepoznatih termina;2) proširene oblike i objašnjenja svih akronima i skraćenica;3) objašnjenja upotrebe neuobičajenih reči, kao što su imenice i prilozi;4) bibliografiju specijalizovanih rečnika i međunarodnih standarda.

c) Upotreba specijalne terminologije treba da se bazira na nacionalnim ili međunarodnim terminološkim standardima, priznatim rečnicima i odobrenom rečnicima pojmova.

d) Svaki akronim terba definisati prvom prilikom kad se akronim pojavi u telu teksta.e) Svaki termin treba konzistentno upotrebljavati kroz dokument, on-line dokumentaciju ili

sistemsku biblioteku.f) Složena fraza kao "kartica za unos" treba da ima samo jedno značenje koje treba koristiti

konzistentno.g) Upotrebu složenih fraza treba ograničiti na tri rečih) Istu reč ne treba koristiti za različite delove izlaganja.i) Sve specifične i specijalizovane termine treba uključiti sa objašnjenjima ili u razumljivom

kontekstuj) Termini koji nisu prepoznatljivi po kontekstu, kao što su ključna imena i komande mora da se

definišu u rečniku pojmova.k) Termin "bilion" treba izbegavati.

Napomena US bilion (=1 000 000 000) nije isto što i stari UK bilion (=1 000 000 000 000).l) Korišćenje termina "prevođenje" koji se odnosi, na primer, na format datoteke treba izbegavati; za

značenja koja su različita od prevođenja sa jednog jezika na drugi, mora se koristiti termin konverzija.

E.3 Stil za prevođenje (Style for translation)

E.3.1 Skraćenice (Abbervation)

Treba koristiti samo široko prepoznatljive skraćenice i treba ih objasniti u listi skraćenica. Treba izbegavati sledeće:

a) US simbol za funtu (#).b) Podignutu tačku za množenje.

E.3.2 Zbunjujuće reči (Confusing words)

Pisci treba da izbegavaju sledeće zbunjujuće reči:a) ko, to, koji.b) samo, jedva, upravo, uglavnom, jednostavno.c) dok.d) tako.e) kao.f) moći, smeti.g) od.

35

h) kada, ako.i) alternativan, alternativno.

E.3.3 Sintaksa (Sintax)

Treba uzeti u obzir sledeće činjenice o sintaksi:

a) Rečenice ne treba da budu dugačke.b) Treba izbegavati rečeničke konstrukcije koje uključuju niz koncepata odvojenih zarezima.c) KOnstrukcije koje se koriste često ili retko treba pažljivo odvojiti.

E.3.4 Interpukcija (Punctuation)

Gde se može upotrebljavati zagrada i tačka zarez, ne treba koristiti crticu.

E.4 Fizički faktori (Physical factors)

Treba imai u vidu sledeće fizičke faktore:

a) Ne treba koristiti skraćenice radi uštede prostora.b) Višak prostora treba ostaviti, na primer za novčane vrednosti.c) Treba koristiti standardne grafičke alate, a treba izbegavati ubacivanje nestandardnih elemenatad) Trabe izbegavati integraciju teksta u ilustracije.e) Treba koristiti opšte priznate grafičke simbole.f) Treba koristiti grafiku da bi se zamenile reči gde god je moguće.

E.5 On-line informacije (On-line informations)

Treba imati u vidu sledeće činjenice u vezi sa on-line informacijama:

a) Ako je moguća kontrola nad razvojem softvera , on-line informacije (tekst i poruke) treba da su izolovane od programske logike.

b) Svaki tekstualni blok ili poruka treba da ima jedinstven identifikacioni kod sa konvencijom imenovanja koja grupe povezuje sa datim tekstom i porukama.

c) Softver ne treba da se oslanja na dužinu, format i poziciju ulaznih i izlaznih polja.d) Za svaku ideju treba da se koristi posebna poruka. Poruke ne treba da budu iskonstruisane.e) Poruke treba da sadrže samo neprevodljive informacije kao što su ključne reči i povratne poruke.f) Predloge ne traba izostavljati iz rečenica da bi se uštedeo prostor.

E.6 Kulturološki faktori (Cultural factors)

Sledeće faktore treba imati u vezi sa kulturološkim faktorima:

a) Umetnički rad (kao lica, životinje i telefoni) treba da budu kulturološki neutralni.b) Treba izbegavati primere koji su specifični za lokalnu kulturu i lokalni način vođenja posla

(odmori, bankarstvo, isplatna lista, sport, itd.)c) Treba izbegavati u tekstu i umetničkom radu izraze koji su specifični za nacionalni jezik

dokumentatora.d) Treba izbegavati humor, posebno dosetke i igru reči.e) Ironiju treba upotrebljavati sa oprezom.f) Treba izbegavati sleng, žargon i običan govor.g) Ne treba koristiti prvo lice.h) Datume ne treba izražavati u numeričkoj formi. Mesec treba da bude označen slovima (npr. 26 juli

1991).

36

i) Treba koristiti dve dimenzije osim gde međunarodne konvencije ne diktiraju drugačije - na primer, veličine guma, vodenih cevi, eksera i filma.

j) Kada pored metričkih postoje i druge mere, treba pojasniti njihov kontekst.

Prilog F(informativan)

Procenjivanje (Estimating)

37

F.1 Uvod (General)

Ovaj prilog sadrži nekoliko metoda procenjivanja koje se daju kao uputstvo. U nekim slučajevima su kontradiktorne; dokumentacija za procenu nije egzaktna nauka. U stvari, procena može biti pogrešna ako se dese izmene na softveru tokom razvoja dokumentacije.

Ove metode mogu da obezbede korisano okruženje, ali stvarno vreme može biti zamenjeno u saglasnosti sa iskustvom procenjivača.

F.2 Metoda "minuti i sati" ("Minutes and hours" methods)

Približno se uzima tri sata po stranici za pisanje teksta standarda koji se objavljuje. Vreme predviđeno radi dizajniranja grafike je određeno složenošću i brojem novih nacrta potrebnih da se obezbedi tehnička ispravnost.

Kao generalna ideja, uzima se tri do pet sati za dizajniranje i dopunu grafike (ne prikaza ekrana) u tipičnoj softverskoj dokumentaciji.

Teško je znati na početku projekta koliko strana će dokumentacija imati. Ako će biti potrebno više od dva meseca da se kompletira projekat, broj stranica treba revidirati na početku prvog meseca.

Za vrlo velike projekte, elemente za isporuku treba podeliti u delove koji su laki za upotrebu. Provenjeno vreme za kompletiranje celog projekta može biti dato u broju celih meseci, detaljima prvog dela. Na ovaj način i dokumentator i naručilac mogu iznova proceniti datum isporuke.

Tabela F.1 prikazuje vremena za "tipični projekat". i predpostavlja se da pisac kuca materijal direktno u PC i da izdavač to koristi.

Tabela F.1 Procenjeno vreme

Faza VremeOdređivanje elemenata isporuke 16 sati po projektuSadržaj istraživanja 24 sata po projektuPisanje dokumentacionog plana 48 sati po projektuDizajn izgleda strukture/strane dokumenta 8 sati po izdanjuPisanje prvog nacrta 1 sat po straniRazvoj grafika 5 sati po graficiObjedinjavanje teksta i grafika 30 minuta po straniPregled tehničke ispravnosti prvog nacrta (naručilac) 30 minuta po straniDopuna nacrta i grafika 30 minuta po straniUgrađivanje korisnikovih primedbi 30 minuta po straniUređivanje gramatike 15 minuta po straniPriprema drugog nacrta 15 minuta po straniPregled drugog nacrta (naručilac) 15 minuta po straniVršenje konačne korekcije 10 minuta po straniIspitivanje dokumentacije 15 minuta po straniPosao pripreme za štempu 3 dana prema proceniŠtampanje poveza/indikatora 5 dana prema proceniŠtamanje i spajanje kopija (samo crna štampa) 10 dana prema proceniDistribucija 1 dan prema proceni

F. 3 Pristup "odozgo na dole" (Top-down approach)F.3.1 Uvod

38

Ovaj metod je zasnovan na pretpostavci da broj strana za publikaciju ili publikacije može biti lako procenjen i koristi sledeće pretpostavke:

a) Pisac može uraditi 22 strane novog teksta za mesec dana.b) Pisac može uraditi 44 strane izmenjenog teksta za mesec dana.

Na primer, procenjeno je da publikacija ima 150 starana. Pošto je nova publikacija, potrebno je 150/22 = 7 čovek/meseci za završetak posla. Ovih 7 meseci uključuju planiranje publikacije, pisanje, uređivanje i pregled dva nacrta i pripremanje kopije za štampu.

F.3.2 Procentualno učešće (Proportions)

Procenjeni rad od 7 čovek/meseci treba podeliti proporcionalno , prema sledećem:

a) 15% za planiranje (4 nedelje u ovom primeru).b) 50% za prvi nacrt (14 nedelja).c) 25% za drugi nacrt (7 nedelja).d) 10% za kopiju za pripremu za štampu

F.3.3 Planiranje (Planning)

Planiranje vremena uključuje:

a) Istraživanje i pisanje plana.b) Kontrolisanje i pregled plana.c) Ažuriranje plana prema rezultatima pregleda.

F.3.4 Prvi nacrt (Firs draft)

Prvi nacrt uključuje:

a) Pripremanje sadržaja.b) Kontrolisanje i pregled sadržaja.c) Pisanje materijala za urednika.d) Pregledanje materijala i modifikacija.e) Pisanje kompletnog nacrta.f) Uređivanje kompletnog nacrta.g) Prerada uređenog nacrta.h) Kontrolisanje i pregled prerađenog nacrta.

Ilustracije su pripremljene u isto vreme kao i tekst.

F.3.5 Drugi nacrt (Second draft)

Drugi nacrt se sastoji od:

a) Ugrađenih svih primedbi iz pregleda prvog nacrta.b) Uređivanja drugog nacrta.c) Prerađivanja nacrta.d) Kontrolisanja i pregleda prerađenog nacrta.

F.3.6 Odobravanje nacrta (Approval draft)

Nacrt spreman za štampu je nacrt za odobravanje i uključuje:

39

a) Ugrađivanje svih primedbi iz pregleda drugog nacrta.b) Provera da su sve izmene izvršene.c) Uklanjanje svih oznaka, kao što su oznake za ispravke i oznake poverljivosti.d) Pripremanje orginala spremnog za štampu.e) Otprema orginala štamparima.

Obično, osobe koje vrše pregled zahtevaju jednu do dve nedelje za kontrolu nacrta i pripremu primedbi, dok sam pregled zahteva jedan ili više dana.

Pristup "odozgo na dole" može se takođe iskoristiti za postojeće publikacije. Na primer, knjiga od 100 strana može se revidirati tako da je potrebno da se polovina izmeni i da se ubaci 10% novog materijala. Potrebno je 50/44 = 1,13 čevek/meseci za izmenu materijala i 10/22 = 0,45 čovek/meseci za dodavanje novog materijala.

Gde proteklo preme prekoračuje dozvoljeno vreme, koristi se više od jednog pisca da bi se završio posao. Ovo je takođe neophodno u slučaju kada je potrebno pripremiti nekoliko publikacija za isti softver.

Prilog G(informativan)

40

Procena dokumentacionog plana (Assessing a documentation plan)

Upotrebom ovog Međunarodnog standarda može se generisati dobra dokumentacija zbog toga što dokumentacioni plan mora da bude dogovoren između naručioca i dokumentatora. Ovim se postužu dva glavna efekta: osigurava se da dokumentator u svakom slučaju razmotri sve aspekte dokumentacije na koje se poziva plan i osigurava se da naručilac i dokumentator dogovore pristup za izradu dokumentacije postavljen u planu, u idelanom slučaju pre nego što počne rad.

Elementi koje naručilac treba da pogleda u dokumentacionom planu su:

a) Sve ciljne grupe treba da su ispravno definisane. Izjava kao: "Ciljna grupa za ovaj priručnik će se sastojati od korisnika softvera" nije dovoljna. Videti prilog D. Svi ljudi koji će možda koristiti softver (uključujući one koji će možda gledati izveštaje) treba da budu uključeni u definiciju ciljne grupe.

b) Detaljan sadržaj treba da je uključen sa očekivanim brojem strana.c) Treba da je specificiran broj štampanih strana i metod štampanja i povezivanja.d) Vlasnik autorskih prava materijala treba da je jasno identifikovan.e) Treba odrediti metod izrade. Danas većina tehničkih dokumentatora za pisanje koriste računar.f) Dokumentator treba da da naručiocu dovoljno vremena za pregled nacrta - svako kašnjenje u

vraćanju nacrta dokumentatoru će verovatno uticati na kašnjenje isporuke.g) Organizacija naručioca može zahtevati da se obezbede resursi (pristup osoblju, opremi, itd), a

izbegavanje istog može dovesti do kašnjenja.

Uopšteno, dokumentacioni plan treba da uzme u obzir sve specifične okolnosti koje okružuju kompaniju naručioca i korisnike. Vrlo je neuobičajeno da se plan koji je napravljen za jedan projekat može iskoristiti uspešno za drugi.

Prilog H(informativan)

41

Primer specifikacije stila (Sample style specification)

H.1 Uvod (General)

Ovaj primer specifikacije stila ispunjava zahteve poglavlja 8.2 ovog Međunarodnog standarda i može se koristiti kao predpostavka u dokumentacionom planu.

Napomena Korisno je na osnovu specifikacije stila, a pre njenog završetka, napraviti model dokumenta.

H.2 Elementi stila (Style elements)

Elementi stila sa predloženim vrednostima dati su u Tabeli H.1 .

Tabela H.1 - Elementi stila i vrednosti

Element VrednostJezik EngleskiRečnik pravopisa i izuzetaka Macquarie rečnik, nema izuzetakaGramatika i upotreba priručnika za stil

Australian Goverment Puplishing Service Style Manual for Authors, Editors and Publisher

Veličina papira A4Orjentacija UspravnaDvostrana ili jednostrana štampa DvostranaRezolucija laserskog štampanja 300 dpi minimumŠirina unutrašnje margine 10 mm/2,4 picasŠirina vanjske margine 10 mm/2,4 picasBoja mastila CrnaBoja papira, težina i kvalitet 80 gsm beli bondRazdelnici NePovez Plastični češalj sa čistim providnom prvom stranom i zadnom

stranom težine 200-260 gsmMetod umnožavanja i kvalitet Svi materijali se fotokopiraju i da budu bez oznaka i umetanjaŠema straničenja strana Strane će biti numerisane sa brojevima 1,2,3 itd, počinjući od

prve strane posle korica.Numerisanje ilustracija i tabela Ilustracije se numerišu sa Slika 1, Slika 2 itd u redosledu u kom

se pojavljuju. Tabele se numerišu sa Tabela 1, Tabela 2, itd u redosledu u kom se pojavljuju.

Broj kolona 1Korišćenje fusnota i zaključnih napomena

Fusnote i zaključne napomene neće biti korišćene.

Pravila straničenja Naslovi se neće nalaziti na dnu stranice. Tabele neće biti podeljene preko strane, osim ako je duža od jedne strane. Svaki naslov Nivoa 1 mora počinjati od desne nove strane

Pravila dubine Povezani materijal se nalazi na istoj strani ili na sučeljenim stranama. Upotrebu podvlačenja, velikih površine sa podebljanim tekstom i svih velikih slova treba izbegavati gde je moguće.Treba koristiti između 40% i 60% aktivniog praznog prostora.

Front and back matters: naslovna strana

Naslovna strana pokazuje naziv proizvoda, verziju proizvoda, datum izdavanja i naslov knjige.

Front and back matters: garancija, autorska prava i i informacije o trgovačkoj oznaci

Nema

Front and back matters, sadržaj Sadržaj prikazuje sve naziva glava, poglavlja i naslova delova sa

42

Element Vrednostbrojem strane

Front and back matters, spisak ilustracija i tabela

Nema

Front and back matters: dodaci NemaFront and back matters: rečnik pojmova

Svaki korišćeni termin koji je nepoznat namenjenoj ciljnoj grupi definisaće se u rečniku pojmova u formi koja je prihvatljiva ciljnoj grupi.

Front and back matters: spisak akraćenica i akronima

Spisak skraćenica i akronima prikazuje svaku upotrebljenu skraćenicu, radi pojašnjenja skraćenice u tekstu. Gde tekst nije dovoljno jasan namenjenoj ciljnoj grupi, dodaje se objašnjenje.

Front and back matters: indeks Indeks se uključuje, sa sadržajem kao u H.3.Front and back matters: redosled Front and back matters se ubacuje u redosledu koji je definisan u

ovoj tabeli sa telom dokumenta između sadržaja i rečnika pojmova.

Vrsta i veličina slova u telu teksta 12 pt Times RomanHorizontalni i vertikalni razmak tela teksta

Telo teksta ima 2 pt ispred i ima udaljenost od leve ivice 30 mm/7 picas. Prored između paragrafa je jedan red.

Poravnnje tela teksta Tekst je poravnat sa leve strane, a ne ravan sa desne.Broj i nazivi nivoa naslova Četiri - Naslov dela, naslov poglavlja, naslov sekcije i naslov

podsekcijeStil teksta naslova Stil naslova je rečenički stil, tj prvo slovo naslova je veliko i bez

znakova interpukcije na kraju naslovaVrsta slova, veličina i razmak svakog nivoa naslova

Svi naslovi su u Times Roman bold, a veličina je prema sledećem: Naslov dela-36 pt, naslov poglavlja - 24 pt, naslov sekcije - 18 pt, naslov podsekcije - 14 pt. Naslovi se poravnavaju sa leve strane.

Iznad svakog naslova nalazi se prazan prostor dva puta veći od veličine naslova, osim gde se naslov nalazi u vrhu stranice. Ispod svakog naslova nalazi se prazan prostor iste veličine kao naslov.

Grafički elementi koji se koriste u naslovu

Nema

Sadržaj zaglavlja Zaglavlja pokazuju naslove poglavlja i sekcije, sa naslovom poglavlja na ivici koja je bliža povezu.

Sadržaj futera Futer pokazuje broj strane na ivici koja je dalja od poveza sa brojem verzije, datumom verzije i naslovom dokumenta na drugoj ivici.

Vrsta slova, veličina i pozicija u zaglavlju

Times Roman 12 pt, na vrhu svake strane, osim na naslovnoj strani.

Vrsta slova, veličina i pozicija u futeru

Times Roman 12 pt, sa brojem strane u Times Roman 12 pt bold na dnu svake strane osim na naslovnoj strani.

Grafički elementi za zaglavlje linija širine 1pt nalazi se na 1 pt ispod zaglavljaGrafički elementi futera linija širine 1 pt nalazi se na 1 pt iznad futeraSadržaj naslova Svaki naslov počinje sa brojem slike iza kojeg se nalazi dvotačka,

a zatim sledi tekst naslova, npr. "Slika 1:.........."Vrsta slova u naslovu, veličina i pozicija

Naslov treba da je pozicioniran ispod slike. Naslov treba da bude u Times Roman 10 pt italik.

Pravila za izgled tabela Tabele su iste širine kao područje za telo teksta i koriste samo pravilo 1 pt

Vrsta slova u tabelama i minimalna veličina

Times Roman sa minimalnom veličinoom 8 pt

Sadržaj izveštaja Izveštaji sadrže stvarne (ali ne ilustrativne) podatke

43

Element VrednostVrsta slova u izveštajima i minimalna veličina

Izveštaji su u Courier 8 pt,

Izveštaji: upotreba položene orjentacije i foldouts

Izveštaji se predstavljaju na papiru položene orjentacije; ne koriste se "foldout"

Sadržaj prikaza ekrana Prikazi ekrana prikazuju stvarne (ali ne ilustrativne) podatkeIzgled prikaza ekrana Prikazi ekrana nisu izobličeni horizontalno ili vertikalno. Iste su

širine kao i područje za štampuFormat ekranskog prikaza za parcijalne prikaze ekrana

Delimični prikazi ekrana (deo ekrana koji se prikazuje) je istih razmera kao celokupan prikaz ekrana

Minimalna širina linije ilustracije, vrsta i veličina slova

Minimalna širina linije: 0,5 pt. Vrsta slova: Times Roman. Veličina: minimalno 8pt

Orjentacija ilustracije Orjentacija ilustracije i teksta na njoj prilagođena je orjentaciji teksta u dokumentu.

Stil teksta upozorenja i opomena Rečenički stil, koji počinje rečima "Upozorenje:" ili "Opomena:"Vrsta i veličina slova i razmak u upozorenjima i opomenama

24 pt Times Roman bold centrirano, sa proredom od dve linije iznad i ispod

Sadržaj teksta sa uputstvima Konteksna pomoć, proširena pomoć, tasteri za pomoć, pomoć za pomoć, poruke za pomoć i ----- treba da postoje

Sadržaj on-line dokumentacije On-line dokumentacija uključuje korisničko uputstvo, uputstvo za komande, uputstvo za poruke i informacije za administratora.

Srodni materijali Informacije o temi nalaziće se na jednom ekranu gde god je to moguće

Naglašavanje i upotreba boja Boje ne treba upotrebljavati u on-line dokumentaciji i tekstu sa uputstvima. Naglašavanje (visoki intezitet) treba upotrebljavati samo za naslove.

Izgled on-line dokumentacije i teksta sa uputstvima

Treba da postoji prazna linija između vrha teksta koji se prikazuje (linija naslova ili vrh ekrana) i prve linije teksta.

Izgled naslova on-line dokumentacije i teksta sa uputstvima

Naslovi treba da budu naglašeni korišćenjem visokog inteziteta. Koriste se samo dva nivoa naslova. Naslovi treba da budu u rečeničkonm stilu (videti 8.2.3.7.2 Stil teksta naslova). Ispred i iza svakog naslova treba da postoji prazna linija.

Izgled tela teksta Tekst treba da bude poravnat sa leve i neravan sa desne strane. Treba da bude prazan prostor od 20 karaktera sa leve strane svake linije teksta

Pravila navigacije Nivo oivičenih informacija se kontrolišu tako da korisnik može lako da se vrati u datu tačku ili sadržaj ili indeks bez osećaja da se izgubio unutar dokumenta.

Upotreba tastature Upotrebljavaju se sledeći tasteri: F1 za pozivanje sistema sa uputstvima. Alt-F4 ili ESC za izlazak iz sistema sa uputstvima. Nije moguće da korisnik izgubi bilo koji podatak koji je već unešen nakon povratka iz sistema sa uputstvima.

H.3 Specifikacija indeksa (Index specification)

H.3.1 Uvod (General)

Svaki dokument koji sadrži 32 ili više strana teksta treba da ima indeks.

Napomena Svi delovi dokumenta treba da budu indeksirani, uključujući uvodni materijal, dodatke, ilustracije i priloge.

44

H.3.2 Kvalitet (Quality)

Treba da su obezbeđeni dovoljni detalji u indeksu radi zadovoljavanja očekivanih potreba ciljne grupe.

Napomena Indeks treba da zauzima od 5% od ukupne dužine dokumenta (za obrazovni priručnik) do 10% (priručnik za upotrebu). Treba razmotriti usluge profesionalnca za kreiranje indeksa.

H.3.3 Sadržaj i organizacija (Content and organization)

Dokumentacija treba da ima jedan indeks, ukoliko to nije drugačije specificirano dokumentacionim planom.

Napomena1 Naslovi (tj. reči ili fraze koje u indeksu predstavljaju termine ili koncepte u dokumentu) treba da su izabrani prvenstveno iz terminologije u dokumentu (npr. računarski softver).

Napomena 2 Jedan termin treba upotrebljavati konzistentno za predstavljanje istog koncepta.

Napomena 3 Podnaslovi koji predstavljaju neki aspekt glavnog naslova često mogu biti toliko značajni i da se koriste kao naslovi samostalno.

Napomena 4 Glavni naslovi treba da predstavljaju koncepte koji se nalaze u dokumentu. Prvenstveno treba koristiti imenice i menjati ih, ako se zahteva, sa pridevima ili drugim imenicama ili glagolima. Kod računarskih komandi koje se koriste u dokumentaciji, ako je to pogodno, treba koristiti imperativni oblik glagola kao glavni naslov.

Napomena 5 Termin koji se sastoji od više od jedne reči treba koristiti kao naziv bez preokretanja ili deljenja u podnaslove.

Napomena 6 Predloge treba izbegavati osim ako njihovo odsustvo izaziva neodređenost.

Napomena 8 Akronimi, skraćivanja i skraćenice treba urediti u abecednom redu.

Napomena 9 Spisak stavki iz indeksa treba urediti reč-po-reč; tj. prazan prostor treba tretirati kao simbol koji je po redosledu pre nekog drugog karaktera (npr. "Alt taster" je ispred "Alternativan").

H.3.4 Upućivanje na poziciju (Location references)

Treba da se odredi upućivanje na poziciju za svaku stavku iz indeksa koja nije cross reference.Upućivanje na poziciju treba da se uredi za svaki broj strane ("1", "2") ili za broj paragrafa ili sekcije ("2.22", "3.34"). Kada su ilustracije indeksirane, može postojati i upućivanje na poziciju za brojeve ilustracija.

Napomena 1 Uobičajeno je da se korisnik upućuje na broj stranice, a na broj paragrafa.Napomena 2 Spisak stavki iz indeksa ne treba da upućuju na veliki broj lokacija. Podesan maksimum je 5 karaktera (1, 33, 43, 99, 102). Da bi se izbeglo upućivanje na veliki broj pozicija koje se ne razlikuju, treba koristiti podnaslove.

Napomena 3 Upućivanje na poziciju glavne rasprave o temi možda treba da bude podebljanim slovima.

Napomena 4 Ako spisak podnaslova zauzima više od jedne kolone, naslov treba da bude ponovljen na vrhu svake dodatne kolone iza koje sledi reč "nastavak".

45

Napomena 5 Tamo gde postoji više nizova broja strana, svaki niz treba da ima različit indeks. Na primer, ako numeracija sa svakim poglavljem počinje iznova, broj poglavlja treba da bude uključen u upućivanje na poziciju, npr. "2-22, 3-34".

Napoemna 6 Ako dokument tretira temu kontinualno kroz deo uzastopno numerisanih sekvenci, samo prvi i poslednji element treba da bude označen; elementi treba da budu odvojeni crticom (konvencionalno "n" crticom) (npr. strane 3-11). Tamo gde se crtice upotrebljavaju u numerisanju strana, ne treba koristiti uobičajenu crticu koja razdvaja brojeve strana, već umesto nje treba koristiti reč "do" (npr. 3-6 do 3-8).

H. 3. 5 Međusobno upućivanjeCross - references

"Videti" cross-reference (npr. dizajn - videti oblik) treba da se napravi od akronima, sinonima i alternativnih oblika upotrebljenih u dokumentu u formu koji je izabran za naslov indeksa.

Napomena Dodatno "videti" cross-references treba da je napravljen od drugih oblika koje će korisnik može tražiti. Iza "videti" cross-references ne treba nikad da bude lokacija na koju se upućuje.

"Videti takođe" cross-references treba da se napravi od više razumljivih do manje razumljivih termina, osim ako ovo ne rezultuje upućivanjem korisnika na identičnu lokaciju.

Napomena "Videti takođe" cross-references treba da poveže termine koji imaju neke druge veze koje mogu pomoći korisniku. "Videti" cross-references ispod naslova treba da bude zajedno sa naslovom posle čega sledi upućivanje na poziciju koja je u vezi sa naslovom ili podnaslovom na koji upućuje. Na primer:

ilustracije 4videti takođe grafike; ekranski prikaziindeksiranje, 12spisak, 15numeracija, 2pisanje za prevođenje, 3, 15

Termini "videti" i "videti takođe" treba da budu italik.

46

Bibliografija

Sledeće publikacije su izabrane zbog toga su lako dostupna u većini javnih biblioteka i zbog toga što sadrže detaljne informacije o određenim informacijama koje su srodne ovom međunarodnom standardu. Ni jedna od ovih publikacija nije korišćena kao osnova za pisanje ovog međunarodnog standarda. Iako su neka poglavlja u ovim publikacijama u suprotnosti sa ovim međunarodnim standardom, sadrže korisne izvore informacija.

Srodni nacionalni i međunarodni standardi

1 ISO 6592, Informaciona tehnologija - Smernice za kompjutersku dokumentaciju-zasnovane na aplikacionim sistemima.2 ISO 9127:1988 Sistemi za obradu informacija - Dokumentacija za korisnika i propratne informacije softverskih paketa za masovnu upotrebu.3 ISO/IEC 12119:1994, Informaciona tehnologija - Softverski paketi - Zahtevi kvaliteta i testiranje4 ISO/IEC 12207:1995, Informaciona tehnologija-Procesi životnog ciklusa softvera5 BS 7649:1983, Uputstvo za razvoj i pripremu dokumentacije za korisnika aplikativnog softvera

Uopšteno

6 BARNUM, C.M. and CARLINER, S., Tehnike za tehnička sapoštenja, MacMillan, 19837 BROCKMANN, R.J. Pisanje bolje kompjuterske korisničke dokumentacije, Wiley, 19908 BRAUSAW, C.T., ALERD, G.J. and OLIU, W.E. Priručnik za tehničko pisanje, St. Martin's Press,19939 BURNETT, R.E. Tehnička saopštenja, Wadsworth Publishing, 199410 HACKOS, J.T. Upravljanje vašim projektima za dokumentaciju, Wiley, 199411 HOLTZ, H. Kompletan vodič za pisanje čitljivih korisničkih priručnika,Dow Jones-Irwin, 198812 HORTON, W.K. Ilustriranje kompjuterskedokumentacije, Wiley, 199113 SIMPSON, H. and CASEY, S.M. Razvoj efektivne koorisničke dokumentacije: Pristup ljudski faktori,McGraw, 198814 WEISS, E.H. Kako napisati upotrebljivu korisničku dokumentaciju,Oryx Press, 199115 ZINSSER, W, O dobrom pisanju, Harper and Raw, 1991

On-line dokumentacija i hipertekst

16 BOGAN, S., FARKAS, D. and WELLINSKE, J. Razvoj on-line dokumentacije za Windows, International Thomson Press, 199517 BROWN, C.M., Čovek-kompjuter dizajniranje interfejsa, Norwood, 198818 HELANDER, (Ed). Pruručnik za čovek-kompjuter međusobni uticaj,Nort Holland19 HORTON, W.K., Dizajn i pisanje on-line dokumentacije. Tekst pomoći ka hipertekstu, Wiley, 199020 HORTON, W.K., Dizajn i pisanje on-line dokumentacije: Hipermedija za ----21 LAUREL and MULDER, Umetnost dizajniranja interfejsa 22 VAN DER VEER and MULDER, Međusobni uticaj čovek-kompjuter. Sprunger-Verlag, 1990

Ispitivanje upotrebljivosti

23 DUMAS, J.S and REDISH, J.C. Praktično uputstvo za ispitivanje upotrebljivosti, Ablex Publishing,199324 NIELSON, J., Tehnika upotrebljivosti, AP Professional, 1993

47