Slik oppretter du et profesjonelt teknisk dokument-del 1

Et teknisk dokument er resultatet av å skape effektiv teknisk brukerinformasjon. Det forklarer heller hvordan noe fungerer eller hvordan man bruker det. Det kan bety forskjellige ting for mennesker i ulike roller. Du kan trenge en slik dokumentasjon til ombord på nye ansettelser, forklare nye funksjoner eller som referanse for personer som ikke er kjent med teknologi.

Skrive et teknisk dokument trenger en rekke verktøy-et skjermbildeapp, et bilderedigeringsprogram, et tekstbehandlingsprogram for å skrive instruksjon og verktøy for å dele dokumentet.

Selv om dette er den beste protokollen for å lage et teknisk dokument, virker det ikke riktig når du mangler tid eller må oppdatere dem med jevne mellomrom.

I denne todelte opplæringen vil jeg vise deg hvordan du bruker avklare å lage enkle og profesjonelle tekniske dokumenter.

Konfigurer appen til å høste maksimale fordeler.
Opprett en grundig opplæring med flere trinn, bilder og tekst.
Del dokumentet med andre mennesker eller på nettet.

Grunner til å velge klargjøre

avklare er et program på tvers av plattformer tilgjengelig for både Windows og Mac-maskiner. Den er kompatibel med versjoner fra Windows Vista til 10 end OS X 10.7 Lion til 10.11 El Capitan og macOS 10.12 Sierra
Den lar deg lage teknisk dokument i små biter og forklare dem trinnvis. Du kan legge til bilder, annotere dem med visuelle verktøy og legge til tekst for å forklare trinnene
Den har en innebygget integrering av verktøy for å la deg dele dokumentet via web, e-post og evernote. Du kan også lagre dem som PDF, HTML og a Ord dokument
Den lar deg lage egendefinert HTML- og PDF-mal, slik at du kan fokusere på oppgaven med å lage et teknisk dokument og ikke bekymre deg om logoer, fonter, farger, topptekst og bunntekst, sideskift og mer

Konfigurere avklare

avklare gir deg få muligheter til å sette det tekniske dokumentet etter dine behov. Gå til Forklar> Innstillinger.

Du får se tre innstillinger: Generell, Dele, og PDF-maler. Hver preferanse lar deg konfigurere flere parametere.

Generelle innstillinger

Velg de generelle innstillingene i avklaringsinnstillingene

Konfigurer hurtigtangene for å ta skjermbilder. For å endre hurtigtast, klikk Fjerne og skriv inn den nye hurtigtasten. Hvis du foretrekker stort lerret for å skrive dine tekniske dokumenter, bytt Dokumentredigerings tekststørrelse fra liten til stor.

avklare lar deg tilpasse bildeinnstillingene, slik du vil. Velg eksportformatet som PNG eller JPEG (bra, bedre, best). Du kan automatisk generere ALT-tagger for bildene, eller automatisk skalere bildene, både bredde og høyde, i henhold til stilguiden.

Dele

Velg delingsinnstillinger i Angi innstillinger. Klikk på + knappen for å legge til en konto

Clarify tilbyr en rekke forskjellige måter å dele dokumentene opprettet på. Du kan eksportere for å avklare-it.com slik at andre kan se dokumenter. Du kan eksportere dokumentet til egendefinert WordPress blogg eller .com-blogg eller lagre dem som PDF, HTML eller a Ord dokument.

PDF-maler

avklare leveres med fire grunnleggende maler: Basic, Black and White, Chrome og Corporate.

Hvis du har noen spesifikke behov, kan du lage din egen PDF-mal. Klikk på + knappen for å opprette en ny egendefinert mal.

Tilpass generelle innstillinger for en PDF-mal. Klikk på + -knappen for å legge til en egendefinert mal

I Generell fan, tilpass sideformat og marginer, bildejustering, innholdsstrøminnstillinger og mer. Når du lager et PDF-dokument, avklare legger til sideskift på bestemte steder. Selv om avklare prøver å holde trinninnhold sammen, du kan konfigurere dem.

Klikk på Innholdsstrøm menyen for å konfigurere sideskiftinnstillinger. Velge Ett trinn per side for å legge til et sideskudd etter hvert trinn.

Velge Pass på som innhold som mulig per side å sette så mye innhold på siden som mulig. Bruk CSS til å kontrollere kontrollen over sideskift.

I topptekstfeltet kan du legge til en logo og tilpass noen få variabler. Du kan legge til variabler som

[[Dokument tittel]] - Navnet på dokumentet
[[Filnavn]] - Navnet på PDF-filen
[[Dato]] - Datoen i formatet som systemet bruker
[[MM / DD / YYYY]] - Måned, dag og år

I bunntekstfeltet kan du legge til sidetal og bunnteksttekst. Du kan legge til variabler som

[[Side nummer]] - Sidenummeret
[[PAGE_COUNT]] - Totalt antall sider

Tilpass skrifter og farger i PDF-malen

I Skrifter og farger fanen, angi standard skrift, skriftstørrelse og farge for topptekst og bunntekst, artikkelbeskrivelse, stegetittel og underskriftstitel. Hvis du ikke angir en skrift for et bestemt objekt, vil den bruke Standard skrift.

Tilpass CSS til en PDF-mal. Å ha kunnskap om CSS lar deg legge til mange variabler

De Tilpasset CSS fanen lar deg gjøre justeringer til elementer som ikke er tilgjengelige i brukergrensesnittet. PDF maler i avklare Fungerer på prinsippet om HTML og CSS. Hvis du har kunnskap om begge, kan du legge til mange variabler i PDF-mal. For eksempel

.trinnbeholder (
side-break-after: alltid
)

Denne CSS forteller PDF-generatoren å alltid legge til en sideskift etter et trinn. Du kan også legge til bestemt skrifttype i PDF-dokumentet ditt ved å legge til bestemte CSS-klasser i dokumentet.

.trinn-tittel (
font-style: kursiv;
font-weight: lettere;
)

Noen av klassene du kan bruke er Artikkelbeskrivelse, trinn-tittel, trinn-container, undertrinn, og trinn-instruksjoner. Ved hvert trinn kan du klikke Forhåndsvisning for å se den endelige utgaven av PDF-malen.

Konklusjon

avklare er en innfødt app for Windows og Mac for å lage tekniske dokumenter. Det lar deg lage maler, slik at du kan fokusere på å lage et teknisk dokument uten oppstyr og administrere flere apper - skjermopptaksverktøy, tekstbehandler og delingsverktøy.

I denne veiledningen har jeg vist deg hvordan du konfigurerer Clarify app for å høste maksimale fordeler og hvordan du konfigurerer maler.

I den neste opplæringen gir jeg en trinnvis fremgangsmåte for å lage et teknisk dokument. Appen inneholder en 14-dagers prøveversjon og er tilgjengelig for $ 29.99. Se prisinformasjonen for mer informasjon.

Dataferdigheter