Comunicare

Documentaţie software : de la inctrucţiuni la integrare Thomas T. Barker Domeniul documentaţiei software este examinat analizând manualele scrise înainte şi după 1985. Schimbările inregistrate in domeniu includ staruirea asupra satisfacerii solicitanţilor, strategii manageriale îmbunătăţite şi noi tehnici de design. De asemenea articolul trece în revistă şi lucrările despre documentaţia software publicate începând cu 1988 şi susţine că tendinţele de după 1985 au un punct de vedere social construcţionist asupra documentaţiei. Într-o introducere la o lucrare viitoare despre documentaţia software, am înregistrat următoarea definiţie: Documentaţia software se referă la modificarea, planificarea şi aplicarea oricărui element de interfată, scris sau on-line, al unui sistem software în scopul sporirii utilizării sistemului. În momentul în care am propus pentru prima oară această definiţie eram informat de fenomenul pe care majoritatea celor care scriu despre software îl numesc “extindrea rolului furnizorului de documentaţie software”. Eram deci la curent ca rolul cel mai important revenea acum nu izolatului scriitor de manuale, ci aceluia a cărui muncă este în întregime integrată în toate aspectele procesului de dezvoltare a sistemului (autorul îl numeşte “tehnical comunicator”). Am plăcerea ca in articolul de faţă sa verific în continuare acea definiţie extinsă, prin ilustrarea modului în care furnizorul de documentaţie software s-a transformat încă de la începutul anilor ’80. Scopul meu în acest articol este să explorez modul în care arta documentaţiei s-a transformat de-a lungul ultimului deceniu (articolul este apărut în decembrie 1990). Astfel voi propune spre examinare trei texte (toate colecţii de eseuri) publicate începand cu 1988. În aceste trei texte şi mai precis în teza propusă de Barrettt, găsim o provocare nouă în documentaţia software. Ceea ce sper să se observe din întreaga documentaţie, este că în urma unei maturizări tehnice şi metodologice, domeniul documentaţiei software este pe punctul de a deveni o forţa modelatoare majoră în direcţia tehnologiei.

Documentaţia software înainte de 1985 Unul dintre textele mai vechi despre scrierea manualelor şi unul dintre cele mai bune ale timpului sau este “How to write computer manuals for users”. Cea ce deosebeşte cartea de intenţiile noastre este faptul că nu reflectă influena tehnologiei computerului asupra procesului scrierii. De exemplu, include o secţiune care arată în ce constă ”Pregatirea manualului pentru a fi tipărit” împreuna cu , aşa cum era de aşteptat, o scurtă secţiune despre folosirea “word-ului” şi procesarea textului. Lucrarea lui Grimm se bazează pe elementele formale ale manualelor (“Introducere”, “Instrucţiuni de aliniere”, “Descrierea randamentului”, etc.) cu fiecare secţiune analizată în detaliu. Un asemenea mod de abordare a fost folositor într-un moment în care existau foarte puţine instrucţiuni formale în legatură cu documentaţia software. Mare parte a informaţiei este folositoare azi, dar, ca şi în alte lucrări ale acelui timp se pune accentul pe rezultatul documentaţiei software nu pe procesul în sine. În plus nu se spune nimic despre online, hypertext, etc. În special, acoperă trei tipuri de manuale: training manual, reference manual şi un manual ce cuprinde combinarea celor două tipuri. Lucrarea lui Jonathan Price “How to write a computer manual: a handbook of software documentation” este cea mai bună dintre cele publicate înainte de 1985, probabil pentru că ofera mai multe informaţii la zi. Cartea a fost rezultatul experienţei dobandite de Price la Apple Inc. ca parte din ceea ce numeau User education group.

Era un mediu bogat în resurse unde furnizorii de documentaţie software erau sustinuţi şi unde atenţia era îndreptată asupra detaliilor materialelor care urmau a fi utilizate. Deşi cartea este cea mai buna şi desigur cea mai cuprinzatoăre dintre toate lucrările din 1984 despre scrierea manualelor are dezavantaje care fac să fie asociată cu o eră anterioară. Deşi este orientată asupra utilizatorului în metodologiile de design, capitolele despre testare, spre exempul, nu reflectă rigorile curente impuse sarcinii. Alte elemente o disting ca pe o lucrare de tranziţie. Include materiale despre ceea ce noi am putea considera o specie de documentaţie online: instruire asistată de computer. Necesită ceea ce noi am numi acum o abordare minimalistă a stilului: să oferi cititorului îndeajuns de multă informatie (“make every segment short”) şi posibilitatea de a recupera erorile (“Catch those errors”) reprezintă începutul ideii extinderii rolului celor care scriu documentaţie software. Secţiunea “Softening up the software” exlicţ modul cum să participi la “software interface design”, cu mult înainte ca icon-ul şi mouse-ul să-şi caştige popularitatea. Pe scurt, cartea, deşi fiind de fapt despre “tutorials şi references (manuale cuprinzand instrucţiuni) conţinea şi idei inovatoare. Alte manuale din acel timp dezvăluie de asemenea elemente ale noii concepţii despre documentatia software. Lucrarea “Softwords Hardwords” a Luciei Mc’Kay marchează o distanţare semnificativă faţă de alte lucrări structurate pe scrierea textelor. Se distinge prin arătarea modului în care sunt scrise manualele la AshtonTate. Cartea lui Peter Stephan “ Writing user-usable manuals” este una dintre primele care subliniază “ utilizabilitatea” ca principiu şi astfel anticipeaza una dintre principalele teme ale unor lucrări ulterioare. O cale de a evalua limitele carţilor despre scrierea manualelor înainte de 1994 este de a discuta tipurile de documentaţie pe care le pun în discuţie. Cum se poate obseva din figura 1 aceste cărţi se limitează la doua forme de bază: “tutorial manual” şi : ”reference manual” (manual de instruire şi manual de indicaţii). AUTHOR Grimm ‘82 Zaneski ‘82 Price ‘84 Stephan ‘84 Katzin ‘85

TUTORIAL X X X X X

REFERENCE X X X X X Figura 1.

ALTELE “combinare” “instalare” “CAI” “hardware”,”troubleshooting” “operatii”

Primul era pentru antrenarea utilizatorului în operaţiile programului, celălalt destinat utilizatorilor avansaţi. Metodologiile de design erau pe punctul de a se schimba, la fel şi rolul celor care scriau documentaţii software şi tehnologice, dar mai presus de toate, cea mai eliberatoare schimbare pentru furnizorii de documentaţie software de la mijlocul anilor ’80 a fost ruperea legăturilor a celor două forme de documentare. Documentaţia software după 1985 In cărţile despre documentaţia software de după 1985 observăm o semnificativă distanăare faţă de tendinţele din trecut. In general diferenţa se observă în trei domenii principale. Cea mai semnificativă era sublinierea rolului utilizatorului ca principal scop al documentaţiei 2

software, nu al producerii manualelor. Celelalte două tendinţe principale se refereau la noi direcţii de dezvoltare în management şi noi tehnici de design. Sublinierea rolului satisfacerii utilizatorului Probabil fiindcă erau foarte mulţi şi foarte puternici din punct de vedere economic, în 1985, utilizatorii au devenit centrul atenţiei furnizorilor de documentaţie. Atenţia nu se mai îndrepta deci asupra sitemului în sine ci asupra manualului. Factorul uman, folosirea softwareului, aplicarea funcţiilor sistemului obţinea acum întaietate. Rezultatul, aşa cum rămâne de văzut era o formă complet nouă de documentaţie grupată mai degraba în biblioteci decât în două grupuri principale. Una din cele mai importante manifestări ale tendinţei este cartea lui Foehr şi Cross “The soft side of software”. Autorii extind conceptul de documentaţie folosind analogii cu diverse concepte umane ca harţi sau ghiduri de utilizare pentru a sublinia rolul umanului asupra sistemului în documentaţia software. Scopul, spun ei, este mai degrabă de a explora din perspectiva modului în care utilizatorul întelege, decât din perspectiva instruirii lui. Şi alti scriitori au ţinut cont de această idee. În lucrarea lui Weiss “How to write a usable user manual”, conceptul de “utilizabilitate” întelegând satisfacerea utilizatorului a devenit al doilea principiu de referinţă după acela al calităţii documentaţiei. Brockmann, deasemenea, în “Writing better computer user documentation” vedea documentaţia ca îndeplinind un rol intermediar între software şi utilizator. Brockmann a mers chiar şi mai departe, susţinând că întregul concept de “software” şi-a schimbat întelesul din “implementation” (aplicabilitate) în “interface”. Părerea lui este că “nici un produs nou, destinat utilizatorului, nu poate fi conceput fără un set de indicaţii asupra folosirii lui”. Foehr şi Cross susţin cam acelaşi lucru în introducerea lucrării lor: “computerele viitorului vor fi judecate mai degrabă după calităţile care promovează întelegerea sistemelor, decât după viteza de procesare sau calitatea de informaţii stocate în memorie”. Astfel, prin insistarea asupra variatelor necesitaţi ale utilizatorilor, furnizorii de documentaţie software s-au detaşat de modelul celor două manuale (reference/tutorial). Probabil că aceasta s-a întamplat şi datoritţ dezvoltării procesului de producţie, motivul cel mai sigur este, cum era de presupus, creşterea numarului de utilizatori ”mici”. Acest lucru a oferit posibilitatea scriitorului de a prezenta noi şi variate tipuri de documentaţie, o adevarata bibliotecă. “Biblioteca” documentatiei software 3

Conceptul de “document library” n-a luat fiinţă în 1985, ci asta s-a întamplat pe la începutul apariţiei sistemelor de procesare automată a datelor. Dar în 1980 a luat un sens nou mult mai creativ. Unul ditre primii care au recunoscut nevoia unei “biblioteci” cu documentaţie software a fost Edmond Weiss. Acesta defineşte ca “produse informaţionale” (“information products”) orice de la carţi, reference cards, videocards, online tutorials etc. Prin aceasta, lasă la o parte cele două categorii principale de manuale (reference şi tutorial) şi defineşte documentaţia prin prisma funcţiilor pe care le îndeplineşte: funcţie coordonatoare (informaţională) – reference function, funcţie instructivă – instruction function (tutorials and documentations) şi funcţie motivaţională. El susţine în principal că furnizorul ar trebui să prezinte nu numai materialul informaţional, ci tot materialul de care utilizatorul are nevoie pentru a fi satisfăcut, indiferent în ce formă. Dezvoltând o idee similară King identifica patru tipuri de manuale: “Course outline”, “Train the trainer manual”, “Instructor’s training guide”, şi “Student reference guide”. Ceea ce o distinge de ideea anterioară este că precizează tipul de document bazat pe nevoile utilizatorului. Într-o altă lucrare, “Creating computer software user guide”, Doann Houghton-Alico, la fel ca şi King şi Weiss, admite nevoia de a “croi” informaţtia în funcţie de nevoile utilizatorilor. Ghidurile informaţionale pe care le prezintă sunt scrise pentru anumite tipuri de utilizatori, bazate pe studierea şi analizarea diverselor profile ale acestora. Documentaţia online Dupa 1985 documentatia onliine a castigat popularitate. Din aceasta directie se contureaza online, hypertext si alte tipuri de inteligenta artificiala. Un exempul de relatie intre sistemele online si inteligenta artificiala poate fi gasit, de pilda in lucrarea “Developing effective user documentation: a human-factors approach” de Simpson si Casey. In aceasta carte autorii discuta un numar de “intelligent” and uninteligent” pentru “help” si alte sisteme online. Noi directii in management Cum era de asteptat, in explorarea in noi cai de acomodare a utilizatorilor, furnizorii de documentatie software au gasit noi modele de structurare a procesului de documentatie manageriala. Inainte de acest moment se realizase destul de putin in sensul sporirii efortului organizarii documentatiei fiindca acest lucru nu era considerat in cadrul caii critice 4

de dezvoltare a sistemului. Dar totul s-a schimbat cand rezultatele din management au devenit din ce in ce mai critice. In manualele de dupa 1985 se gaseste un numar de strategii pentru producerea lucrarilor informationale. Weiss, de exemplu, descrie un proces structurat in cinci nivele. Brockmann foloseste un plan pentru producerea unui proiect de documentatie numit “procesul documentatiei standard”.Casey adopta de asemenea un model standardizat “Documentation development process” care are drept scop imbunatatirea proiectului managerial. Honghton-Alico deasemenea adopta o aborbare sistematica a documentatiei software, specializandu-se pe dezvoltarea simultana a sistemelor de documentatie. Ghidul pe care-l propune subliniaza importante preocuparii de dezvoltare a documentatiei online in management. Astfel furnizorii de documentatie software au deveni constienti de interesele din management implicate in documentatie si diverse documentatii de management. De asemenea au inceput sa examineze eforturile de echipa in cadrul careia se gaseste documentatia software. Aceasta a devenit o tendinta foarte puternica astazi. Dezvoltarea echipelor: Foehr si Cross subliniaza rolul crearii unei echipe de documentatie cu jucatori si planuri ale jocului. Din punctul lor de vedere, management-ul devine mai specializat si reflecta mai mult schimbarile in cultura moderna. Introduc un termen interesant – furnizorul de documentatie software inteles ca “khowlodge worker”. Weiss si King staruie de asemenea asupra dezvoltarii echipelor. In particular, Weiss subliniaza un fel de reabilitare a “solitarului” (creative writer) model in documentatie si evidentiaza o strategie iterativa in management, prin care manualul, in urma unei extinderi a muncii de design, iese afara din proces. Noi directii in documentatia software. In ultima parte a lucrarii ma voi ocupa de examinarea unui numar de trei texte din MIT Presscare reprezinta, fiindca sunt colectii de eseuri (unele originale, altele nu), cateva din cele mai gandite carti tratand subiecte discutate pana acum: forme de documentatie, tehnologii online, si hypertext, avansate strategii in management. “Efective documentation: What we have learn from research Stephen Dohney Farina, ed., MIT Press, Boston, MA 1988. Aceasta carte are patru parti si este dedicata informarii cititorilor despre eforturile realizate in domeniul cercetarii si in domeniul documentatiei software. In timp ce analizeaza studiile de cercetare dirijate 5

in arii specifice (“Textual, graphic, and online information”, si “The comunication context: management and reserch”) ofera si informatii despre studiile realizate pana acum (“Overview”, “Research findings and design”). Asa ca ofera informatiide valoare atat profesionistului, cat si unui potential cercetator interesat de continuarea activitatii de cercetare ca parte a dezvoltarii procesului. “Text context, and hypertext” – Edward Barrett. Aceasta lucrare in trei parti stidiaza natura informatiei scrise despre computere (“Artificial inteligence, document procesing, and hypertext”), mediile in care astfel de situatii sunt folosite (“Management training, and corporate culture”) siforma in care exista in informatia (“Deseigning the on-line information”). Scopul cartii este, asa cum sustine autorul de a incepe sa integreze domeniile de scriere, management si stiinta computerelor. Multe din eseurile prezentate in carte au fost la origine prezentate ca parte integranta a “Conference on writing for the computer industry” sub indrumarea lui Barrett la MIT. “The society of hypertext, hypermedia and the social construction of information” – Edward Barrett, ed., MIT Press, Boston, MA 1989. Cartea acopera urmatoarele domenii: • hypertext si hypermedia: sisteme de design pentru utilizatorul online. • Multimedia si nonlinear information arhitectures, • Perspectiva sociala: management si mediul online • Sensemaking,learning si mediul online. Eseurile cuprinse aici au in vedere notiunile de hypertext,dezvoltarea online, design si inteligenta artificiala. Prima directie a textului dat in introducere “Thought and language in a virtual environement” in care Barrett dezvolta ideea unei schimbari in paradigma in literatura despre tehnologia calculatoarelor. In aceasta introducere clarifica distinctia dintre modelul procesului cognitivde documentatie si modul social constructionist, aducand argumente in favoarea celui de-al doilea. Barrett sustine ca in esenta tentul este un construct social, iar hypertextul o paradigma. Din argumentatia lui Barrett reiese clar faptul ca vede tehnologia – Calculatoare si retele – nu ca pe o simpla prezenta, ci ca parte a totului organic in care se include scrierea si calculul. Barrett citeaza un numar de teoreticieni - mai ales pe Papert si Vigotski ale caror lucrari reflecteaza un foarte avansat punct de vedere asupra naturii informatiei. Din aceasta perspectiva, stiinta este un proces social, un aedvar in virtutea acceptarii unui grup de subiecti cunoscatori. I n esenta informatia sau stiinta nu este vazuta ca o marfa care este transferata utilizatorului prin intermediul manualelor, ci ca un rezultat al actiunii utilizatorilor cu tehnologia

6

calculatoarelor si cu ceilalti utilizatori prin sisteme care specifica aceasta interactiune. I conceptia lui Barrettacele sisteme sunt in principal sisteme ale limbajului. “Limbajul”, sustine el, utilizarea acestuia in structurarea si descoperirea informatiei precum si calculatorul, inteles ca sprijinind procesul social care defineste folosirea limbajului, devin principalul obiectiv. Din acest punct de vedere cei care ofera documentatie software nu satureaza ci stimuleaza descoperirea si structurarea informatiei. Tot asa ei nu impartasesc invatatura ci o co-creaza alaturi de utilizatori. Ei nu instruiesc ci stimuleaza interactiunea. Barrett numeste acest model “social constructionist” si il opune modelului procesului modelului cognitiv initiat de Jean Piaget si de B.F.Skinerr. Argumentul lui Barret este ca modelul social constructionist asupra documentatiei reperzinta o noua paradigma pentru “lucrarile din domeniul dezvoltariitehnologiei de calcul”. Concluzie: In introducere au sugerat o definitie asupra documentatiei software care batea atat de departe incat sa sugereze chiar faptul ca furnizorul de documentatie software are de jucat un rol legitim in toate aspectele sistemului de dezvoltaresi utilizare.Asa cum s-a putut vedea,extinderea rolului acestuia a fost rezultatul unei distantari semnificative devechile forme de documentatie care existau la mijlocul anilor ’80. De la caeasta data cei implicati in procesul de informare asupra computerelor au anticipat necesitatile utilizatoruliu cum mai multa seriozitate, au sprijinit prezenta lor in management si si-au reformulat ideile despre modul de structurare a informatiei.Incepand de atunci, acele tendinte, asa cum s-a putut observa, s-au transformat in ceea ce noi consideram acum o conceptie matura in procesul informatiei, una bazata pe teoriidestul de avansate asupra domeniului de documentatie.Ceea ce a devenit scopul principal al documentatiei software, poate fi privit intr-o noua lumina: participarea utilizatorilor si tehnologiei pregatind un viitor si mai promitator.

7