Instrucțiuni tehnologice ce au nevoie și ceea ce constituie
Întrebări generale documentare
comunicare tehnică: Situația problemei
Documentația sistemelor și a infrastructurii IT
standard 34
De ce Standard 19 și Standard 34
Un sistem automat în ceea ce privește GOST 34
Un sistem automat în ceea ce privește GOST 34. Continuare
O fantomă a GOST
Atașarea unui document „pentru un cod de acces“
infrastructuri de documentare
Documentarea infrastructurii IT a organizației
procesul de documentare
Prelucrarea instrucțiuni: de ce sunt necesare și că reprezintă?
Atunci când este necesar să se înceapă reglementarea activităților și trecerea la managementul regulat?
managementul documentației
Abordarea evaluarea condițiilor de creare a documentației tehnice
Tehnica și stilul de prezentare
Care ar trebui să fie ghidul utilizatorului
Cum funcționează lumea? secțiunea Noțiunea manualul de utilizare
Cum de a scrie documentația în limba engleză?
unelte
Elaborarea documentației tehnice pe baza unei singure surse
Scrie BAT-fișiere pot fiecare!
Flare MadCap: un sistem pentru elaborarea documentației tehnice pe baza unei singure surse
Catalogul ilustrat al pieselor și ansamblurilor pe standardul S1000D
Microsoft Word
Microsoft Word pentru un scriitor tehnic
Recomandări pentru sistemul de stil în șabloane pentru documentația tehnică
DITA
Tehnologia DITA: prezentare generală a caracteristicilor și avantajelor principale
Cerințe de documentare folosind DITA
DocBook / XML
DocBook / XML: platformă deschisă pentru dezvoltarea documentației tehnice
Personalizarea aspectului documentelor de ieșire din DocBook / XML
Setarea FO-procesoare pentru a afișa caractere chirilice în mediul Microsoft Windows
CMDB Documente
Diagrame „stimul-răspuns“ - o alternativă la modelul tradițional de proces de afaceri
documentare Problemele cu personalul
Cine sunt scriitorii tehnici?
scriitor tehnic. competență profesională de bază
scriitor tehnic în lumea mare, de specialitate si profesie >>
standardizare
Oaspeții proiectului pe stilul
ANSI Z535.6 - avertizare standard de cravată în documentația tehnică
măsuri
Conferința „astăzi Documentarea“
Introducere în DITA. înregistrare webinar
traducere
A. Klimenko. Traducere Meșteșug >>
HAT și CAT
alte
Cum de a scrie o lucrare pe termen lung și nu caca pantalonii cuiva pe urechi
Humane de lucru în Microsoft Excel
Ca o estimare convingătoare, planul și raportul cu date numerice
Contextul tehnologiei documentului
instruire tehnologică - unul dintre documentele operaționale furnizate de serie de standarde de stat 34. Reamintim că această serie de standarde pentru sisteme automatizate (AS), în special, documentația acestora. De multe ori, un astfel de document este numit, de asemenea, regulamente, precum și descrierea de locuri de muncă, dar ultima opțiune pare să ne foarte nefericit, și chiar înșelătoare, deoarece fișele de post sunt departamentele de resurse umane și de a servi unui scop complet diferit.
Conform definiției date în GOST 34.003-90, AC include în mod necesar hardware, software și de personal. De exemplu, Microsoft Excel ca atare - este un produs software, și secretarul, care este așezat la calculator și să scrie într-un anumit fel de masă marcate apelurile primite - UA, deși destul de mici. Pentru o descriere a software-ului sunt documente, cum ar fi managementul de utilizare, ghidul administratorului de sistem (după litera a standardului - Sistemul programator) Ghidul programatorului. Există diverse documente care descriu mijloace tehnice. instrucțiune tehnologică - documentul cel mai „uman“, descrie acțiunile implicate în activitatea personalului UA, cu alte cuvinte, utilizatorii. Acesta este aspectul formal al problemei.
Astfel, problema instrucțiunilor tehnologice - corelează funcționalitatea software-ului sistemului automatizat cu practica, descrie activitatea membrilor UA pe fond.
Pentru a numi doar câteva motive pentru o astfel de decizie poate fi fără succes.
În primul rând, aceleași funcții de software pot fi utilizate de către diferiți angajați atunci când efectuează diverse operații. Vom descrie fiecare operațiune, în mod repetat, descrieri repetate ale aceleași caracteristici de software? Dacă este așa, atunci documentul va crește puternic în volum. Dacă nu, descrierea unor astfel de descrieri ar trebui să „facă paranteze“: așezați-le în secțiunile speciale de undeva la începutul documentului și pentru a furniza link-uri către aceste secțiuni ale secțiunilor care descriu în mod direct operațiunea. Dar o astfel de decizie este echivalent cu a scris două documente colectate sub o copertă!
În al doilea rând, există programe care sunt din când în când sunt finalizate, dar există organizații în care au loc reforme. Ce un lucru poate fi o variabilitate considerabila alta. Colectarea parte programatic și organizațional într-un singur document, vom face mai dificil să se actualizeze și să armonizeze, în special având în vedere că partea de program ar putea să negocieze cu dezvoltatorii, și manageri instituționale. Reprezentanții fiecărei „fracțiunii“, în acest caz, va trebui să lucreze printr-o mulțime de lucruri pe care nu are nici o legătură directă cu el. În plus, se întâmplă adesea ca după instalarea și punerea în aplicare a unui formale stabilizat, în general, de a practica de lucru pentru a se agită în jos de ceva timp. Apoi, instrucțiunile tehnologice dezvoltate de documentare mult mai program de mai târziu, precum și pe baza informațiilor furnizate de către utilizatori AS, nu de către dezvoltatorii săi.
În al treilea rând, există riscul ca, în documentul fuzionat pentru copacii pădurii este vizibilă. Supraîncărcat cu detalii tehnice ale cea mai mare parte a textului utilizatorul va fi dificil să se ordinea de executare a unei operațiuni izola. Aceasta din urmă poate preveni, de asemenea, oferind starea instrucțiunilor tehnologice ale documentelor organizatorice și administrative. Full folio plin cu „capturi de ecran“, tabele și proceduri detaliate, este dificil de a aproba comanda si pentru a da spre examinare în conformitate cu pictura.
Care este manualul de instrucțiuni? Poate că instrucțiuni tehnologice pot fi scrise în diferite moduri, dar aici va oferim felul în care ne-am aplica.
instruire tehnologică, de regulă, este atribuit un rol funcțional specific. Dacă managerul de vânzări un singur difuzor, contabil, magazioner, secretar, apoi pentru fiecare dintre ele are propriul manual de instrucțiuni scrise. Acesta oferă descrierea celor și numai acele operațiuni care sunt specifice unui singur tip de utilizator.
În afară de service și secțiuni introductive, manualul de instrucțiuni este o colecție de descrieri ale operațiunilor. Fiecare operație este descrisă într-o secțiune separată (secțiunea, punctul - în funcție de structura specială a documentului). Este de dorit ca secvența descrisă în documentul care corespunde secvenței de ei înșiși operațiunile în viață, dar nu este întotdeauna posibil din diferite motive.
Acum este necesar să se clarifice ce se înțelege prin operația. Noi recunoaștem imediat că o definiție formală strictă a operațiunii avem, dar există o descriere liberă, care să permită delimitarea acestui concept.
Operațiunea noi numim o acțiune coerentă efectuată de către o entitate pentru o perioadă limitată de timp și conduce la un rezultat, semnificativ orice mijloace pentru a realiza aceasta. Client de facturare - operare. De ce? În primul rând, de către client ar trebui să fie scris în orice caz, chiar dacă UA înseamnă, deși pe pergament stilou condei. În al doilea rând, obținerea unui cont client înseamnă că, în relația noastră cu el a fost o anumită schimbare. Dimpotrivă, introducerea detaliilor clientului în domeniul ecranului „Cont“ sau nu se imprimă operațiuni reprezintă aceleași motive pentru care operațiunea nu este înmuierea pene de gâscă în călimară.
Indiferent de stilul și designul de descriere pentru a descrie operațiunile sunt în mod necesar prezintă următoarele coloane sau coloane:
- Declanșare, și anume eveniment sau circumstanță, la apariția căruia utilizatorul efectuează operația. Un declanșator poate fi orice extern la eveniment utilizator (tratamentul de contrapartidă, un alt angajat, dispoziția șefului, sosirea unui document sau mesaj), la debutul unui anumit punct de pe un program stabilit, sau o soluție personalizată. Enumerați declanșatoare pentru a descrie operațiunea este necesară, pentru că nimeni nu în mintea lui dreapta și de memorie nu arunca la proiectul de lege pentru nici un motiv aparent. Dacă nu spune utilizatorului atunci când el trebuie să efectueze o operație, nu va face vreodată.
- Rezultatul operației, adică, o schimbare semnificativă a situației care are loc după punerea sa în aplicare cu succes. Rezultatul nu trebuie confundat cu datele de ieșire sau a documentelor. Deci, rezultatul real al facturii nu este hârtie, ci o datorie și / sau clientul își poate permite să ne plătească, nevoia de a urmări oferta de bani în contul, rezervarea mărfurilor atunci când este vorba de a ține cont de plăți în avans, etc.
- Pas cu pas descriere a operațiunii, precum și valoarea de caracteristici de detaliu care au determinat în mare măsură UA. Cu toate acestea, unele dintre caracteristicile sale caracteristice pot fi identificate. Fiecare pas descriere se referă la o singură problemă care trebuie rezolvată fie prin software-ul sau „lumea reală“. De exemplu, un obiect poate fi un ecran de apel pe un formular de introducere a datelor și de la ea. Căutare copie tare a documentului de pe raft poate fi, de asemenea, considerată ca o etapă separată, nu numai soluția pentru a automatiza sarcinile. În descrierea ambele sarcini automatizate și non-automate, vom încerca pe cât posibil, pentru a minimiza cantitatea de detalii tehnice. Descriind, să zicem, completarea unui formular, specificați care câmpuri sunt necesare, poate duce la „captură de ecran“, a formularului completat, dar descrierea caracteristicilor de căutare elementul dorit în directorul sau un calendar pentru a introduce data va fi deja de prisos, astfel de informații este locația în ghidul utilizatorului sau în ajutor context.
Descrierea operațiunii poate fi completată cu alte rubrici utile. Odată ce are sens pentru a specifica modul de a verifica succesul operațiunii, și în același timp pentru a explica ce să facă în cazul în care operațiunea nu a reușit. Se întâmplă să fie una și aceeași operație după caz, sau ar trebui să fie efectuate în mod substanțial în mai multe moduri, adică, desigur, ar trebui să se reflecte în descrierea acestuia. Toate aceste detalii și mișcarea minim necesar pentru supraîncărcare de informații.
Instrucțiuni tehnologice și descrieri ale proceselor de afaceri
Ceea ce este diferit de manualul de instrucțiuni care descrie un proces de afaceri? De fapt, cele două documente spune despre operațiunile, numai în diferite moduri în care sunt grupate. În descrierea operațiunilor proceselor de afaceri colectate de care aparțin acestui proces de afaceri, precum și instruirea tehnologică pe baza performanței lor un purtător al unui rol funcțional. Se pare că, dacă „tăiat“ toate instrucțiunile tehnologice cu privire la tranzacțiile individuale, atunci fragmentele rezultate vor fi posibilă „lipici“ descrierea tuturor proceselor de afaceri. În unele cazuri, acest lucru este adevărat, dar, în practică, de multe ori se întâmplă ca o parte a instrucțiunilor tehnologice, putem relativ ușor și descrierea satisfăcătoare a proceselor de afaceri devine un obiectiv dificil de realizat.
Membrii și răspunsul lor la diverse evenimente există în mod obiectiv. Putem solicita un manager sau contabil specific, „În ce condiții te-ai fi facturat? De ce faci asta? Ce se întâmplă după ce o faci?“, Iar el este de natură să dea la această întrebare este clar, deși nu întotdeauna un răspuns laconic.
proces de afaceri, dimpotrivă, este subiectivă, este unul dintre oamenii dezvoltat metode de a descrie propriile lor activități. Nu întâmplător, la o petrecere Series 34 acest concept nu este, dar există un concept mai larg al modelului de informare. Modelele de informare pot veni cu foarte diferite. Putem descrie vânzarea de bunuri către client ca un proces, si poate ca un ciclu de viață al unui ordin emis de către client, referindu-se la acesta din urmă ca un obiect aparte ( „tranzacționeze“), care trece calea deschisă.
Din cauza dezordinii și arbitrariu există un loc întotdeauna absolut clar, procesele de afaceri strict repetabile, probabil, nu va găsi oriunde în altă parte. Utilizarea aparatului conceptual al proceselor de afaceri, suntem capabili să descrie nu realitatea, dar faptul că există sau ar trebui să fie merge bine. Norma este, în primul rând, întotdeauna cineva postulat și, în al doilea rând, trebuie să fie luate în timpul unei astfel de majoritate. În multe organizații, reprezentarea consecventă a normei nu există (una se uită la situația din partea lor), astfel încât orice descriere proces de afaceri este smulsă o mare parte din echipă.