Slik oppretter du et faglig teknisk dokument-del 2

Opprette et teknisk dokument

Du har en ny Mac og vil konfigurere Internett for å få tilgang til Internett. Du er redd for at du kanskje glemmer trinnene, eller kan være nyttig for andre. I dette eksemplet lager jeg et enkelt, teknisk teknisk dokument og lagrer det som et PDF-dokument.

1. Legg til emnet og artikkelbeskrivelsen

Skrive den Emne og en kort Artikkel Beskrivelse. Det bør være kort, klart og nøyaktig fortell de tingene du vil vise, i dette tilfellet vil du sette opp Internett på en Mac. De Emne Linjen vises på sidelinjen til avklare dashbord.

Klikk Fil> Lagre som og velg mappen der filen skal lagres. Som standard velger den emnet for avklare dokument som et filnavn med utvidelsen som .avklare og lagrer den i Forklar dokumenter mappe.

Opprett emne og artikkelbeskrivelse

2. Legg til et trinntittel og punkttekst

Klikk på + symbol for å legge til et nytt trinn. Skrive den Trinntittel og avsnitt tekst i sine respektive bokser. 

Hvis du gjør en feil, klikker du i boksen for å redigere den. Når du legger til en Trinntittel Du vil se trinntittelen i sidebjelken til avklare dashbord.

Lag stegetittel og paragraftekst. 1. Trinn tittel 2. Del tekstboksen

3. Formater paragrafteksten

avklare tilbyr en rekke alternativer for formatering av teksten. Formatlinjen vises når du velger feltfeltboks. Klikk på et av ikonene for å endre formatet på teksten. Du kan velge mellom Modig, kursiv, Bullet liste, link, hevet og mer. 

Når du trykker på returknappen, avklare vil opprette et nytt avsnitt. avklare legger til mellomrom mellom hvert avsnitt som du vil se i tekst på et nettsted.

Forskjellige avsnittformateringsalternativ i Clarify

avklare lar deg også formatere kode som hele blokker med kode eller som enkelte ord i en setning. For å merke et ord eller to som kode, velg ordet og klikk Formater som kode knappen fra formateringsverktøylinjen.

Når du eksporterer avklare dokument som HTML, vil teksten være vedlagt ...  tags. Velg hele avsnittet og klikk Formater som kode, å konvertere teksten til en kodeblokk med utdataene som følger med 

... 

 tags.

Kodeformateringsalternativer i Clarify

4. Ta skjermbilder

Du har tre alternativer for å ta bilder 

1. Capture knappen i klargjør appen
2. Capture knappen fra menylinjen, eller 
3. Tastatursnarveier

Gå til Forklar> Innstillinger og i Generell innstillingene konfigurer hurtigtastene.

Tar skjermbilde fra Capture-knappen

Når du trykker på Capture knapp skjermbilde verktøy vil vises på skjermen. Dra over området du vil fange og trykk på Komme tilbake nøkkel. trykk Mellomrom å fange et fullt vindu. trykk Mellomrom igjen for å gå tilbake til regionopptaksmodus.

trykk R å sykle gjennom de tidligere regionene du har tatt. Det er nyttig når du vil fange det samme området på skjermen igjen og igjen. trykk C for å vise eller skjule markøren mens du tar skjermbilde.

Skjermbildeverktøy på skjermen. Den inneholder noen nøkler for å gjøre skjermbilde arbeidsflyten mye raskere

5. Gjøre grunnleggende oppgaver med bilder

avklare gir mange muligheter til å manipulere bilder: rotere, beskjære, bruk grunnleggende annoteringsverktøy, endre størrelse på bilder og bildedekken. 

For å rotere bildet, klikk Rediger> Roter bilde.

Roter et bilde i Clarify

For å beskjære bildet, klikk Rediger> Beskjær bildet. Klikk og dra over området du vil beholde, og trykk på Komme tilbake nøkkel.

Beskjær et bilde i Clarify

Du kan velge mellom en rekke annotasjonsverktøy. Velg bildet og klikk på annotasjonsverktøyet du vil bruke fra formateringsverktøylinjen: Linjeverktøy, Firkantet verktøy, Sirkelverktøy, Sekvensnummereringsverktøy (du kan tilpasse startsekvensen), Tekstverktøy og Slør verktøy.

Tilleggsverktøy for type linjer i Clarify

avklare har tre muligheter for å endre størrelsen på bildene. Den har fire håndtak rundt sidene av bildeditoren. Klikk og dra noen av disse håndtakene for å endre størrelsen på lerretet. Du kan ikke beskjære et bilde ved hjelp av disse lærredhåndtakene. 

Dra og hold Alternativ nøkkel til å endre størrelsen på alle sidene av lerretet likt.

Endre størrelse på lerret av et bilde gjennom håndtak

Bruk håndtaket for å endre størrelsen på bildet i nederste høyre hjørne. Klikk og dra dette håndtaket for å endre størrelsen på bildet. Trykk og hold inne Alternativ nøkkel for å endre størrelsen på bildet i trinn på 10%.

Endre størrelsen på bildet gjennom et håndtak som er plassert nederst til høyre

For presis kontroll over bildestørrelsen, klikk primært på trinnbildet og velg Endre størrelsen på bildet ... . Hvis trinnet har flere bilder, må du velge et bestemt bilde og deretter endre størrelsen på dem via en kontekstuell meny.

Endre størrelsen på bildet gjennom en kontekstmeny 

6. Opprette under-trinn eller nesting trinn

avklare har muligheten til å lage under-trinn. Et under-trinn er innrykket under foreldre-trinnet og kan være ett nivå dypt. Når du eksporterer dokumentet, vises en under-flis på en annen måte i en liten skriftstørrelse, under-trinns nummerering (hvis du aktiverer det). Først opprett det vanlige trinnet som beskrevet tidligere.

Velg trinnet du vil lage et under-trinn. Gå til Dokument> Flytt trinn menyen og flytt trinnet Ikke sant å strekke den inn. Flytt under-trinnet opp eller ned å organisere det tekniske dokumentet, etter behov.

Opprette under-trinn i Clarify

7. Automatisk nummerering av trinnene

Når det tekniske dokumentet innebærer en rekke trinn, kan du prefikse dem med et tall. avklare vil automatisk nummer trinn, klikk Dokumentinspektør og sjekk Automatisk nummer trinn. Alle andre trinn blir automatisk prefiks med tall.

Auto nummer trinn i Clarify

For å utelukke et trinn fra å få et prefiks, klikk på Trinninspektør og kryss Ekskluder fra Auto-nummer. Det trinnet vil ikke lenger være prefiks med et nummer.

Ekskluder et trinn i Clarify

Det kan være situasjoner der du ikke ønsker å automatisk nummerere toppnivåstrinnene, men bare substepene. For å gjøre det, klikk på Trinninspektør og sjekk Auto-nummer subsystemer. Bare undertekstene vil bli prefiks med tall.

Auto nummer subeps i Clarify. Hvis denne funksjonen ikke virker, er det trolig en feil

8. Utføre avanserte oppgaver med bilder

avklare inneholder noen avanserte funksjoner for å manipulere bilder. Selv om disse funksjonene er tilgjengelige på andre bildeditorer, har de i avklare gjør prosessen med å lage teknisk dokument mye raskere. Hvis du vil legge til en ramme rundt bilder, velger du trinnene du vil redigere.

Klikk på Trinninspektør og innenfor Bildeinnstillinger seksjonen endrer Bildegrense du vil legge til for bildene. Du kan velge mellom Linje, Bilderamme, og Avrundede hjørner.

Legg til bildegrense i avklare. Du kan velge mellom Linje, Bilderamme og Avrundede hjørner

avklare kan automatisk skalere bildene og redusere dem hvis de er for høye eller brede.

Klikk på Dokumentinspektør og sjekk Auto-skala bilder. Still inn maksimumet høyde, eller bredde av bildet eller begge deler.

Automatisk skala bilder i Clarify uten behov for et bilde editor

Å legge til flere bilder i et trinn er også en tidkrevende prosess. Klikk på + tegn ligger bare til siden av lærredhåndtaket. 

Ta skjermbildet, og du finner dem inkludert i trinnet.

Å legge til flere bilder til et trinn er enkelt og uten å fange rundt apper

Hvis du har konfigurert Gjenta sist skjermbilde du trenger ikke å bry deg om verktøy for skjermopptak. Bildet legger like under toppbildet, og så videre.

Legge til flere bilder i ett enkelt trinn. Hvis du må ta skjermbilde av samme område flere ganger, konfigurer hurtigtast Repeat Last Screenshot

Hvis du ønsker å erstatte et bilde for et bestemt trinn, velger du bildet du vil erstatte, og klikker deretter på Bytt bilde ikonet øverst til venstre. 

Eller klikk på Erstatte ikonet ligger ved siden av lerrethåndtaket.

Erstatt bilde i klargjør 1. Erstatt bildeikon 2. Bytt ikon nær lerrethåndtak

9. Legge inn en vertsbasert video i et trinn

Et teknisk dokument vil være enkelt å følge hvis du tar med en video. Med avklare Du kan legge inn videoer som er vert for videotjenester, for eksempel YouTube lett inn i trinnene. 

Velg trinnet, klikk på Trinninspektør og endre Media type fra Bilde til HTML.

Endre medietype i trinninspektør fra bilde til HTML

Når du gjør dette, ser du en boks for å sette inn HTML-kode. Gå til YouTube, og kopier innkoden til videoen. Klikk Forhåndsvisning for å se forhåndsvisningen av HTML-en.

Lim inn embed kode i boksen. Velg embedkoden fra Youtube-videoen

Noen eksportformater kan ikke vise HTML-en for et trinn. Klikk på Bilde kategorien og legg til et bilde, for denne typen eksportformater. 

Du må alltid bruke bilderepresentasjonen når du eksporterer avklare dokument til Ord (DOCX forlengelse).

Legg til et bilde for å vise HTML 

10. Legg til anker til trinn i HTML-utgang

Du kan legge til ankerkoder til trinn som vil tilordne som ID-egenskapen i HTML-utdata. Dette kan være nyttig for å koble direkte til bestemte trinn når du deler en avklare dokumentere på nettet. 

For eksempel, hvis du setter ankernavnet for et steg til spesielle-trinns og hvis din avklare dokumentadressen er

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

så kan du koble direkte til trinnet ved å legge til # Spesielle trinn til nettadressen:

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

Hvis du vil legge til ankerkoder i et trinn, velger du trinnet du vil redigere. Klikk Trinninspektør og innenfor Trinninnstillinger sett ankernavnet. 

Når du setter opp et ankernavn, bruk bare bokstaver, tall, bindestreker eller understreker.

Legg til ankerkoder i trinnene i Clarify dokument

Merk: Hvis du ikke angir et anker for et trinn da avklare vil automatisk generere koder basert på intern ID som avklare tilordner til trinn når du oppretter dem. Disse ankeretikettene forblir det samme hver gang du eksporterer avklare dokument.

11. Eksporter og del Clarify Document

Gå til Forklar> Innstillinger og klikk Dele. Klikk på + knappen og velg delingskonto for eksportmål. En delingskonto kan eksportere til Clarify-it.com, WordPress og Evernote. Du kan også eksportere din avklare dokumentere som PDF, HTML og Word.

For å dele kontoer må du ha en konto og autorisasjon. For PDF, HTML, velg eller tilpass malen du vil bruke hver gang.

Opprett deling av kontoer i avklare

Du kan tilpasse malen for PDF, HTML. E-post og Word. I HTML-mal kan du velge mellom flere maler: Grunnleggende, Chrome, Corporate, Markdown, Technical og til og med egendefinert HTML-mal. 

Velg logoen og sett bildedimensjonene for denne malen. Klikk på Forhåndsvisning knappen for å se malen du tilpasset.

Tilpass HTML-mal i Clarify

Du kan også tilpasse e-postmalen på samme måte. Siden det skal brukes PDF, kan du tilpasse PDF-malen og velge e-postklienten: Apple Mail, Postkasse, Outlook eller Airmail. Klikk på Forhåndsvisning knappen for å se malen du tilpasset.

E-postmal i Clarify. Velg e-postklienten du foretrekker

Konklusjon

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

I denne veiledningen har jeg vist deg trinnvis prosedyre for å lage et teknisk dokument. Appen inneholder en 14-dagers prøveversjon og er tilgjengelig for $ 29.99. Se prisinformasjonen for mer informasjon.