Share
Un document tehnic este rezultatul creării unor informații tehnice eficiente pentru utilizatori. Ea explică fie cum funcționează ceva, fie cum se folosește. Ar putea însemna lucruri diferite pentru oameni în diferite roluri. Este posibil să aveți nevoie de o astfel de documentație pentru a angaja noi angajați, pentru a explica noi caracteristici sau ca referință pentru persoanele care nu au experiență în tehnologie.
Scrierea unui document tehnic necesită un număr de instrumente - o aplicație de screenshot, un editor de imagini, un procesor de text pentru scrierea instrucțiunilor și instrumente pentru partajarea documentului.
Deși acesta este cel mai bun protocol pentru a face un document tehnic, nu pare corect când vă lipsiți de timp sau trebuie să le actualizați periodic.
În acest tutorial în două părți vă voi arăta cum să utilizați Clarifica pentru a crea documente tehnice simple și profesionale.
Clarifica vă oferă câteva opțiuni pentru a seta documentul tehnic conform nevoilor dvs. Mergi la Clarificați> Preferințe.
Veți vedea trei preferințe: General, Acțiune, și Șabloane PDF. Fiecare preferință vă permite să configurați mai mulți parametri.
Alegeți setările generale din preferințele de clarificareConfigurați tastele rapide pentru a face capturi de ecran. Pentru a schimba tasta rapidă, faceți clic pe Elimina și tastați noua tastă rapidă. Dacă preferați panza mare pentru a vă scrie documentele tehnice, schimbați Dimensiunea textului editorului de documente din mic la mare.
Clarifica vă permite să particularizați setările de imagine, așa cum doriți. Selectați formatul de export ca PNG sau JPEG (bun, mai bun, cel mai bun). Puteți genera automat etichete ALT pentru imagini sau puteți să scalați automat imaginile, atât în lățime cât și înălțime, conform ghidului de stil.
Alegeți setările de partajare din Preferințe de clarificare. Dați clic pe butonul + pentru a adăuga un contClarify oferă o serie de modalități diferite de a partaja documentele create. Puteți exporta pentru a clarify-it.com, astfel încât ceilalți să poată vizualiza documente. Puteți exporta documentul în funcție personalizată WordPress blog sau .com sau salvați-le ca PDF, HTML sau a Cuvânt document.
Clarifica vine cu patru șabloane de bază: Basic, Black and White, Chrome și Corporate.
Dacă aveți anumite nevoi specifice, puteți crea propriul dvs. șablon PDF. Apasă pe + pentru a crea un nou șablon personalizat.
Personalizați setările generale ale unui șablon PDF. Faceți clic pe butonul + pentru a adăuga un șablon personalizatÎn General filă, personalizați dimensiunea și marginea paginii, alinierea imaginii, setările fluxului de conținut și multe altele. La generarea unui document PDF, Clarifica adaugă pauze de pagină în anumite locații. Cu toate ca Clarifica încearcă să păstreze conținutul pas împreună, le puteți configura.
Apasă pe Conținutul fluxului pentru a configura setările de întrerupere a paginilor. Alege Un pas pe pagină pentru a adăuga o pauză de pagină după fiecare pas.
Alege Potrivi cât mai mult conținut pe pagină pentru a pune cât mai mult conținut pe pagină. Utilizați CSS pentru a controla în continuare pauzele de pagină.
În câmpul cu antet puteți adăuga a Siglă și personalizați câteva alte variabile. Puteți adăuga variabile, cum ar fi
Accentsconagua
[[Titlul documentului]] - Numele documentului[[Nume de fișier]] - Numele fișierului PDF[[Data]] - Data în formatul folosit de sistem[[LL / ZZ / AAAA]] - Luna, ziua și anulÎn câmpul de subsol puteți adăuga numere de pagină și text subsol. Puteți adăuga variabile, cum ar fi
[[Numărul paginii]] - Numărul paginii[[Numărul de pagini]] - Numărul total de pagini
Personalizați fonturile și culorile șablonului PDFÎn Fonturi și culori , setați fontul implicit, dimensiunea fontului și culoarea pentru antet și subsol, descrierea articolului, titlul pasului și titlul substratului. Dacă nu setați un font pentru un anumit obiect, atunci acesta va folosi Implicit font.
Personalizați CSS-ul unui șablon PDF. Având o cunoaștere a CSS vă permite să adăugați mai multe variabile CSS personalizat vă permite să efectuați ajustări ale elementelor care nu sunt disponibile în interfața cu utilizatorul. Șabloane PDF în Clarifica lucrează pe principiul HTML și CSS. Dacă aveți cunoștințe despre ambele, puteți adăuga mai multe variabile în șablonul PDF. De exemplu
.pas-container (page-break-after: întotdeauna)
Acest CSS spune ca generatorul PDF să adauge întotdeauna o pauză de pagină după un pas. De asemenea, puteți adăuga un anumit stil de font în documentul dvs. PDF prin adăugarea de clase specifice CSS în document.
.pas-titlu (font-style: italic;font-weight: mai usor;)
Unele dintre clasele pe care le puteți utiliza sunt Articolul-Descriere, pas-titlu, pas-container, subfaza, și pas-instrucțiuni. La fiecare pas puteți face clic previzualizare pentru a vedea rezultatul final al șablonului PDF.
Clarifica este o aplicație nativă pentru Windows și Mac pentru a crea documente tehnice. Vă permite să creați șabloane, astfel încât să vă puteți concentra pe crearea unui document tehnic, fără a fi afectați și să gestionați mai multe aplicații - instrument de captare a ecranului, procesor de text și instrumente de distribuire.
În acest tutorial, v-am arătat cum să configurați aplicația Clarify pentru a obține beneficii maxime și cum să configurați șabloane.
În următorul tutorial, voi da o procedură pas cu pas pentru crearea unui document tehnic. Aplicația include o încercare de 14 zile și este disponibilă pentru 29,99 USD. Consultați detaliile de stabilire a prețurilor pentru mai multe informații.
