Cum se creează un document tehnic profesional - partea 2

Crearea unui document tehnic

Aveți un Mac nou și doriți să configurați Internetul pentru a accesa Webul. Vă temeți că ați putea uita pașii sau că ați putea fi de folos altora. În acest exemplu, voi crea un document tehnic simplu, pas cu pas și îl voi salva ca un document PDF.

1. Adăugați subiectul și descrierea articolului

Scrie Subiect și o scurtă Descriere articol. Ar trebui să fie scurtă, clară și să spui cu precizie lucrurile pe care doriți să le arătați, în acest caz doriți să configurați Internetul pe un Mac. Subiect line apare pe bara laterală a Clarifica tablou de bord.

Clic Fișier> Salvare ca și selectați dosarul în care trebuie salvat fișierul. În mod implicit, selectează subiectul Clarifica document ca nume de fișier cu extensie ca .clarifica și îl salvează în Clarificați documentele pliant.

Creați subiectul și descrierea articolului

2. Adăugați un titlu pas și un text paragraf

Apasă pe + simbol pentru a adăuga un nou pas. Scrie Titlul pasului și textul paragrafului din casetele respective. 

Dacă faceți o greșeală, faceți clic pe casetă pentru ao edita. Când adăugați a Titlul pasului veți vedea titlul pasului în bara laterală a Clarifica tablou de bord.

Creați titlul pasului și textul paragrafului. 1. Titlul pasului 2. Caseta text paragraf

3. Formatați Textul paragrafului

Clarifica oferă o serie de opțiuni pentru formatarea textului. Bara de formatare apare atunci când selectați caseta câmpului paragraf. Faceți clic pe una dintre pictograme pentru a schimba formatul textului. Puteți alege de la Îndrăzneţ, Cursiv, Listă bullet, Legătură, Exponent și altele. 

Când apăsați tasta de întoarcere, Clarifica va crea un nou paragraf. Clarifica adaugă spațierea fiecărui paragraf așa cum veți vedea în text pe un site web.

Diferite opțiuni de formatare a paragrafelor din Clarify

Clarifica vă permite să formatați codul ca blocuri întregi de cod sau ca cuvinte individuale în cadrul unei propoziții. Pentru a marca un cuvânt sau două ca cod, selectați cuvântul și dați clic pe Format ca cod din bara de instrumente pentru formatare.

Când exportați Clarifica document ca HTML, textul va fi închis ...  Etichete. Selectați întregul paragraf și faceți clic pe Format ca cod, pentru a converti textul într-un bloc de coduri cu ieșirea inclusă în 

... 
 Etichete.

Opțiunile de formatare a codului din Clarify

4. Luarea de imagini

Aveți trei opțiuni pentru capturarea imaginilor 

  1. Captură în aplicația Clarify
  2. Captură din bara de meniu sau 
  3. Comenzi rapide de la tastatură

Mergi la Clarificați> Preferințe și în General setările de configurare a tastelor rapide.

Luând captura de ecran din butonul Captură

Când apăsați pe Captură butoanele de captare a ecranului cu butoane vor apărea pe ecran. Trageți peste zona pe care doriți să o capturați și apăsați pe Întoarcere cheie. apasă pe Spațiu bar pentru a captura o fereastră completă. apasă pe Spațiu bar din nou pentru a reveni la modul de captură în regiune.

presa R pentru a parcurge regiunile anterioare pe care le-ați capturat. Este util atunci când doriți să capturați aceeași zonă a ecranului din nou și din nou. presa C pentru a afișa sau a ascunde cursorul în timp ce faceți captură de ecran.

Instrument de captare a ecranului pe ecran. Acesta include câteva chei pentru a face fluxul de lucru al ecranului mult mai rapid

5. Realizarea sarcinilor de bază cu imagini

Clarifica oferă mai multe opțiuni de manipulare a imaginilor: rotiți, decupați, utilizați instrumentele de adnotare de bază, redimensionați imaginile și panza imaginii. 

Pentru a roti imaginea, faceți clic pe Editare> Rotire imagine.

Rotiți o imagine în Clarify

Pentru a decupa imaginea, faceți clic pe Editați> Decupați imaginea. Faceți clic și trageți deasupra zonei pe care doriți să o păstrați și apăsați pe Întoarcere cheie.

Decupați o imagine în Clarify

Puteți alege dintr-un număr de instrumente de adnotare. Selectați imaginea și faceți clic pe tipul de instrument de adnotare pe care doriți să îl utilizați din bara de instrumente de formatare: Instrument linie, Instrument pătrat, Instrumentul pentru cercuri, Instrument de numerotare a secvențelor (puteți personaliza secvența de pornire), Instrument de text și Blur instrument.

Tipul instrumentelor de adnotare a liniei din Clarify

Clarifica are trei opțiuni de redimensionare a imaginilor. Are patru mânere pe marginea editorului de imagini. Faceți clic și trageți oricare dintre aceste mânere pentru a modifica dimensiunea panzei. Nu puteți decupa o imagine utilizând aceste mânere pentru panza. 

Glisați și țineți apăsată tasta Opțiune cheie pentru a redimensiona toate laturile pânzei în mod egal.

Redimensionați panza unei imagini prin mânere

Utilizați mânerul pentru redimensionarea imaginii din colțul din dreapta jos. Faceți clic și trageți acest mâner pentru a redimensiona imaginea. Apăsați și mențineți apăsată tasta Opțiune pentru a redimensiona imaginea cu incrementări de 10%.

Redimensionați imaginea printr-un mâner situat în colțul din dreapta-jos

Pentru control precis asupra dimensiunii imaginii, faceți clic primar pe imaginea pasului și selectați Redimensionați imaginea ... . Dacă pasul are mai multe imagini, trebuie să selectați o anumită imagine și apoi să o redimensionați printr-un meniu contextual.

Redimensionați imaginea printr-un meniu contextual 

6. Crearea de sub-pași sau pași de încadrare

Clarifica are capacitatea de a crea sub-etape. Un sub-pas este indentat sub pasul părinte și poate fi un nivel profund. Atunci când exportați documentul, o dală sub-pas va apărea diferit într-o dimensiune mică a literei, sub-pas (dacă activați). La început, creați pasul obișnuit așa cum este descris mai devreme.

Selectați pasul pe care doriți să faceți un sub-pas. Mergi la Document> Deplasare pas și mutați pasul dreapta să o indentăm. Deplasați sub-pasul sus sau jos să organizeze documentul tehnic, după cum este necesar.

Crearea de sub-pași în Clarify

7. Numerotarea automată a pașilor

Atunci când documentul tehnic implică un număr de pași, atunci îi puteți prefixa cu un număr. Clarifica va efectua automat numere de pași, faceți clic pe Inspector de documente și verificați Etapele numerelor automate. Toți ceilalți pași vor fi prefixați automat cu numere.

Numărul automat de pași în Clarify

Pentru a exclude un pas din obținerea unui prefix, faceți clic pe Inspector de pas și bifați Excludeți de la numărul Auto. Acest pas nu va mai fi prefixat cu un număr.

Excludeți un pas în Clarify

S-ar putea să existe situații în care nu doriți să numiți automat pașii de nivel superior, ci doar pașii. Pentru aceasta, faceți clic pe Inspector de pas și verificați Numerele automate ale numerelor. Doar subcategoriile vor fi prefixate cu numere.

Numărul de subiecte automate din Clarify. Dacă această caracteristică nu funcționează, atunci este probabil un bug

8. Efectuarea de sarcini avansate cu imagini

Clarifica include câteva caracteristici sofisticate de manipulare a imaginilor. Deși aceste caracteristici sunt disponibile pe alte editoare de imagini, având în ele Clarifica face procesul de creare a documentului tehnic mult mai rapid. Pentru a adăuga o margine în jurul imaginilor, selectați pașii pe care doriți să îi editați.

Apasă pe Inspector de pas și în interior Setări imagine secțiunea schimbă Limita imaginii pe care doriți să le adăugați pentru imagini. Puteți alege de la LiniaRamă foto, și Colturi rotunjite.

Adăugați marginea imaginii în Clarify. Aveți posibilitatea să alegeți dintre linia, rama de imagini și colțurile rotunjite

Clarifica poate scala automat imaginile și le poate reduce dacă sunt prea înalte sau largi.

Apasă pe Inspector de documente și verificați Imagini de scară automată. Setați valoarea maximă înălţime, sau lăţime din imagine sau ambele.

Scalarea automată a imaginilor în Clarify fără a fi nevoie de un editor de imagini

Adăugarea mai multor imagini într-un pas este un proces care consumă mult timp. Apasă pe + semn amplasat doar în partea laterală a mânerului pentru panza. 

Luați captura de ecran și le veți găsi incluse în pas.

Adăugarea mai multor imagini într-un pas este ușoară și fără a fi anunțat în jurul aplicațiilor

Dacă ați configurat Repetați ultima captură de ecran nu trebuie să vă deranjez cu privire la instrumentele de captare a ecranului. Imaginea se adaugă chiar sub imaginea de sus și așa mai departe.

Adăugarea mai multor imagini într-un singur pas. Dacă trebuie să faceți captura de ecran a aceleiași zone de mai multe ori configurați tasta rapidă Repeat Last Screenshot

Dacă doriți să înlocuiți o imagine pentru un anumit pas, selectați imaginea pe care doriți să o înlocuiți, apoi faceți clic pe Înlocuiți imaginea pictograma din colțul din stânga sus. 

Sau faceți clic pe A inlocui pictograma situată lângă mânerul panzei.

Înlocuiți imaginea în Clarify 1. Înlocuiți pictograma imaginii 2. Înlocuiți pictograma lângă mânerul panzei

9. Încorporați un videoclip găzduit într-un pas

Un document tehnic va fi ușor de urmărit dacă includeți un videoclip. Cu Clarifica puteți încorpora videoclipuri găzduite pe servicii video cum ar fi YouTube cu ușurință în trepte. 

Selectați pasul, faceți clic pe Inspector de pas și schimbați Tip media din Imagine la HTML.

Schimbați tipul de material în inspectorul pasului de la imagine la HTML

În acest sens, veți vedea o casetă pentru introducerea codului HTML. Mergi la YouTube, și copiați codul de încorporare al videoclipului. Clic previzualizare pentru a vedea previzualizarea codului HTML.

Inserați codul de încorporare în casetă. Alegeți codul de încorporare de pe videoclipul YouTube

Unele formate de export nu pot afișa codul HTML pentru un pas. Faceți clic pe Imagine și adăugați o imagine pentru aceste tipuri de formate de export. 

Trebuie să utilizați întotdeauna reprezentarea imaginii atunci când vă exportați Clarifica documentul către Cuvânt (Extensie DOCX).

Adăugați o imagine pentru a vizualiza codul HTML 

10. Adăugați Anchor la pașii în ieșire HTML

Puteți adăuga etichete de ancoră la pașii care vor atribui ca proprietate id în ieșire HTML. Acest lucru poate fi util pentru conectarea directă la anumiți pași atunci când faceți o partajare a Clarifica documentați pe web. 

De exemplu, dacă setați numele ancorei pentru un pas speciale pas și dacă dvs. Clarifica adresa URL a documentului este

http://www.myblog.com/my-article.html

atunci puteți să vă conectați direct la pas prin adăugarea # Speciale pas la adresa URL:

http://www.myblog.com/my-article.html#special-step

Pentru a adăuga etichete ancore la un pas, selectați pasul pe care doriți să îl editați. Clic Inspector de pas și în interior Setări pas setați numele ancorării. 

Când configurați un nume de ancoră, utilizați numai litere, numere, cratime sau subliniere.

Adăugați etichete de ancoră în pașii din documentul Clarificați

Notă: dacă nu stabiliți o ancoră pentru un pas atunci Clarifica va genera automat etichete bazate pe ID-ul intern care Clarifica atribuie pașilor când le creați. Aceste etichete de ancorare vor rămâne aceleași de fiecare dată când exportați Clarifica document.

11. Exportați și distribuiți documentul Clarify

Mergi la Clarificați> Preferințe și faceți clic pe Acțiune. Apasă pe + și alegeți contul de partajare pentru obiectivele de export. Un cont de partajare poate fi exportat către Clarify-it.com, WordPress și Evernote. De asemenea, puteți să vă exportați Clarifica document ca PDF, HTML și Word.

Pentru partajarea conturilor, trebuie să aveți un cont și o autorizație. Pentru PDF, HTML, selectați sau personalizați șablonul pe care doriți să îl utilizați de fiecare dată.

Creați conturi de partajare în Clarify

Puteți personaliza șablonul pentru PDF, HTML. E-mail și Word. În șablonul HTML puteți alege dintr-un număr de șabloane: Basic, Chrome, Corporate, Markdown, Tehnic și chiar șablon HTML personalizat. 

Selectați sigla și setați dimensiunile imaginii pentru acest șablon. Apasă pe previzualizare pentru a vedea șablonul personalizat.

Personalizați șablonul HTML în Clarify

De asemenea, puteți personaliza șablonul de e-mail în același mod. Din moment ce va utiliza PDF, puteți personaliza șablonul PDF și puteți selecta clientul de e-mail: Apple Mail, Postbox, Outlook sau Airmail. Apasă pe previzualizare pentru a vedea șablonul personalizat.

Șablonul de e-mail din Clarify. Alegeți clientul de e-mail pe care îl preferați

Concluzie

Clarifica este o aplicație nativă pentru ferestre ș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 avea probleme ș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 procedura 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.