Î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
Originea și rolul caietul de sarcini S1000D
Vorbind foarte pe scurt, caietul de sarcini S1000D - un standard internațional pentru documentația tehnică în industria aerospațială. Acesta nu este un standard ISO, dar în multe țări, în special avansate tehnologic, este folosit ca un standard de facto, nu numai în industria aerospațială, dar și în alte domenii în care este necesar pentru a colecta, organiza și publică volume mari de informații tehnice - de exemplu, construcții navale și auto.
În prezent, trei organizații lucrează la caietul de sarcini, fiecare dintre acestea reprezintă o asociație comercială majoră:
- Asociația Europeană ramuri aerospațială și de apărare (aerospațiale și de apărare Asociația Industriilor din Europa - ASD);
- Asociația Americană a industriilor aerospațiale (Aerospace Industries Association of America - AIA);
- Asociația întreprinderilor, SUA privind transportul aerian (Air Transport Association - ATA).
Unele dintre conceptele-cheie ale S1000D
Piese ilustrate catalog și unități de asamblare este, de asemenea, considerată o publicație tehnică, indiferent dacă acesta este pe hârtie ca o broșură (carte) sau reprezintă hipertext, existente tipărite numai pe cale electronică.
Permiterea diferite tipuri de specificații tehnice publicații impune cerințe detaliate uniforme destul de stricte pentru structura și designul lor. Stringență poate surprinde specialist intern în documentația tehnică, obișnuiți cu faptul că standardele occidentale sunt de obicei mai vagi și liberală decât cea română.
În funcție de modulele sale de date de conținut sunt împărțite în funcție de tipul - de exemplu, catalogul ilustrat al modulului și unitatea de circuit electric aparțin diferitelor tipuri. Pentru fiecare tip de module, compoziția datelor, care poate sau ar trebui să existe prezente, și care să indice care datele sunt obligatorii și care sunt opționale. Modul catalog ilustrat de informații părți într-un mod structurat - este de date și grafice obligatorii detalii și informații cu privire la zonele în care există părți - date opționale.
Catalogul ilustrat al pieselor și ansamblurilor cu privire la specificația S1000D
În versiunea 4.0 caietul de sarcini S1000D cataloage de piese și unități de asamblare ilustrate sunt reglementate de secțiunea 5.3.1.3 (eventual în versiunile viitoare acest lucru se va schimba).
Principalele funcții îndeplinite de un catalog ilustrat de piese și unități de asamblare, în conformitate cu caietul de sarcini sunt:
- identificarea produselor, componentelor acestora și piese de schimb obiect de documentare (avion, navă, etc.), în cadrul proiectului;
- furnizarea de informații cu privire la relația dintre părțile componente ale produsului (detalii de intrare în unități de obiect, interschimbabilitatea pieselor, și altele.);
- furnizarea de informații despre comandarea / livrarea pieselor și a unităților de asamblare (de exemplu, numărul de produse per livrări unitare - complete, cutie, etc unități pentru unitatea de livrare, marca condițiile speciale de depozitare a produselor ..).
Specificația definește următoarele proprietăți ale catalogului ilustrat al pieselor și a unităților de asamblare:
- tipuri de module de date incluse în catalog;
- o structură de directoare cerințe;
- Catalog de proiectare pentru imprimare;
- Design de pagini ale catalogului electronic;
- Unități de date director schema în XML;
- Procedura de înregistrare pentru detalii incluse în catalog.
Figura 1. Structura catalogului ilustrat al pieselor și a unităților de asamblare.
Fig. 2 prezintă fișier XML structura ilustrat catalogul de piese și unități de asamblare.
Figura 2. Structura XML-fișier catalog ilustrat de piese și unități de asamblare
Fig. 3 prezintă structura de date a catalogului modulului ilustrat al pieselor și a unităților de asamblare.
Figura 3. Structura datelor modulului catalog de piese și unități de asamblare (XML) este ilustrat. Sursa: S1000D specificații versiunea 4.0.
Fig. 4 prezintă XML markup modulul ilustrat catalogul pieselor și a unităților de asamblare.
Figura 5. interactiv catalog ilustrat electronic de piese și a unităților de asamblare pregătite în aplicația TGBuilder (exemplu utilizează programul TGBrowser)
ilustrații
Prepararea unui catalog ilustrat
Pregătirea cataloage la comanda ia unor organizații specializate. Costul serviciilor lor depinde de numărul de module din catalog și dacă să se pregătească ilustrații necesare. Pregătirea ilustrațiilor, în special tridimensional, poate fi o parte semnificativă a costurilor.
- Catalog electronic ilustrat în format XML pentru schema S1000D.
- forma tipărită a catalogului ilustrat în format PDF.
Pentru a crea un director, vom avea nevoie de două seturi de date:
- Lista pieselor și a unităților de asamblare, care ar trebui să fie incluse în director. Pentru fiecare piesă sau ansamblu de unitate trebuie să conțină o listă cu desemnarea sa, numele complet, informații privind locația în produs într-un format grafic sau tabelar și numărul de piese sau unități de asamblare din acest produs sau subsistem produse.
- Setați o imagine a pieselor și a unităților de asamblare.
Printre instrumentele specializate pentru pregătirea standardelor S1000D includ: