serviciile noastre
Cum te putem ajuta
Consultări și comentarii
Elaborarea documentației tehnice pentru produsele pentru nevoile de stat
Elaborarea documentației tehnice pentru serviciile de aplicare
Elaborarea documentației pentru produse comerciale
introducerea DITA
traducere tehnică
standarde
ESKD (GOST 2)
ESPD (GOST 19)
KSAs (GOST 34)
ISO / IEC
obiecte
dispozitive
programe
Complexe
platformă
procese
sistem
infrastructură
documente
instrucțiuni
implementare
CCC de operare
tehnologic
descriere
programe
sistem
limbă
conducere
administrator
operator
utilizator
operare
programator
chim. administrator
alte
formularul de sistem
Sistemul de referință complet format din cel puțin două părți, și conținutul total.
În partea generală a materialului includ, în general, toate manualele disponibile: utilizatorul sau operatorul. administrator. Administrator de sistem, precum și alte documente, desigur, dacă este cazul. Mai mult decât atât, materialul, care, datorită volumului mare de imprimare neprofitabile pe hârtie sau inconfortabil să caute într-un document liniar, de multe ori includ doar în sistemul de ajutor. Acest lucru este valabil în special pentru descrierile bibliotecilor de funcții și clase.
În cadrul sistemului de referire includ:
- descrierea fiecărui mod și caseta de dialog;
- sfaturi cu privire la elemente ale ferestrei principale, ferestre de documente și casete de dialog;
- sfaturi pentru elementele de meniu și butoane pe bara de instrumente;
- Sfaturi pentru a utiliza termenul.
O parte comună a cititorului utilizează atât un e-book.
Tehnica și stilul de prezentare
Sistemul de ajutor - un hipertext. Despre ce cerințe trebuie să le îndeplinească pentru avantajele sale peste linia de text nu a fost negata, scris multe cărți și chiar mai multe articole. Ele ocupa mai ales pe site-urile pe care documentația tehnică, desigur, este diferit. Neputându să se îngropa adânc în problemele aici și acum, vom prezenta câteva reguli de bază pentru scrierea hipertext.
- Ar trebui să se străduiască să se asigure că fiecare secțiune a fost un articol de sine stătător, cu un volum limitat în general (deși nu complet) clar pentru cititor în mod izolat de restul materialului. Cu alte cuvinte, secțiunea ar trebui să fie ceva de genul unui articol enciclopedie sau un răspuns în profunzime la o întrebare pe cineva. Acest lucru se poate realiza, în special textul redundant mai activ (definiții, concepte) decât în documentul liniar.
- În cazul în care o înțelegere completă a secțiunii este imposibilă fără o discuție a unor alte subiecte de ajutor, pe care ar trebui să se facă referință. De asemenea, este recomandat să se facă referire la definițiile termenilor folosiți în text.
- Hypertext exclus (deoarece lipsite de sens) referințe implicite de la o secțiune la alta, care sunt realizate în text liniar folosind expresii „așa cum sa menționat mai sus.“ „După cum se va arăta mai jos,“ și așa mai departe. N.
Cu toate acestea, în practică, sistemul de referință este adesea un manual de text, prezentate într-un format electronic specific. Ceea ce nu este bun pentru mediul de afaceri, dar este mult mai ușor și mai ieftin.
Pachetul de software INEC-asigurător 5.0, modulul „Contabilitate“. Sistemul de ajutor în format HTML Ajutor Microsoft
INEC-asigurator - un pachet software proiectat pentru a automatiza activitățile societăților de asigurare. Versiunea 5.0 pachet software inclus mai multe module de aplicații, dintre care unul era modulul „Contabilitate“. Pachetul de software INEC-asigurătorul emis de INEC. „Filosoftom“ a elaborat documentația tehnică pentru versiunea sa a cincea. Fig. 1 arată fereastra „Contabilitate“ modul de ajutor.
Figura 1. Sistemul de ajutor în format HTML Ajutor Microsoft
