Så här skapar du ett professionellt tekniskt dokument - Del 2

Skapa ett teknisk dokument

Du har en ny Mac och vill konfigurera Internet för att komma åt webben. Du är rädd för att du kan glömma stegen, eller kan vara till hjälp för andra. I det här exemplet ska jag skapa ett enkelt, stegvis teknisk dokument och spara det som ett PDF-dokument.

1. Lägg till ämnet och artikelbeskrivningen

Skriv Ämne och en kortfattad Artikelbeskrivning. Det ska vara kort, tydligt och precis berätta vad du vill visa, i det här fallet vill du installera Internet på en Mac. De Ämne raden visas på sidofältet på Klargöra instrumentbräda.

Klick Arkiv> Spara som och välj den mapp där filen ska sparas. Som standard väljer den ämnet för Klargöra dokument som ett filnamn med filnamn som .klargöra och sparar den i Förtydliga dokument mapp.

Skapa ämne och artikelbeskrivning

2. Lägg till en stegtitel och punkttext

Klicka på + symbol för att lägga till ett nytt steg. Skriv Steg Titel och stycktext i respektive fält. 

Om du gör ett misstag, klicka på rutan för att redigera den. När du lägger till en Steg Titel Du kommer se stegtiteln i sidofältet på Klargöra instrumentbräda.

Skapa stegtitel och punkttext. 1. Stegnamn 2. Stycke textrutan

3. Formatera avsnittet Text

Klargöra erbjuder ett antal alternativ för att formatera texten. Formatfältet visas när du markerar fältfältet. Klicka på en av ikonerna för att ändra formatet på din text. Du kan välja mellan Djärv, Kursiv, Bullet lista, Länk, Exponent och mer. 

När du trycker på returknappen, Klargöra kommer att skapa en ny paragraf. Klargöra lägger till mellanrum mellan varje stycke som du ser i text på en webbplats.

Olika styckeformateringsalternativ i Clarify

Klargöra kan du också formatera kod som hela block av kod eller som enskilda ord i en mening. Om du vill markera ett ord eller två som kod markerar du ordet och klickar på Formatera som kod knappen från formateringsverktygsfältet.

När du exporterar Klargöra dokument som HTML, kommer texten att bifogas ...  taggar. Välj hela stycket och klicka på Formatera som kod, för att konvertera texten till ett kodblock med utgången inbäddad 

... 
 taggar.

Kodformateringsalternativ i Clarify

4. Ta skärmdumpar

Du har tre alternativ för att ta bilder 

  1. Fånga knappen i programmet Clarify
  2. Fånga knappen från menyraden, eller 
  3. Tangentbordsgenvägar

Gå till Förtydliga> Inställningar och i Allmän inställningarna konfigurerar snabbtangenterna.

Tar skärmdump från Capture-knappen

När du trycker på Fånga knappsättningsverktyg kommer att visas på skärmen. Dra över det område du vill fånga och tryck på Lämna tillbaka nyckel. tryck på Mellanslag att fånga ett helt fönster. tryck på Mellanslag igen för att gå tillbaka till regioninspelningsläge.

Tryck R att cykla genom de tidigare regionerna du har tagit. Det är användbart när du vill fånga samma område på skärmen om och om igen. Tryck C för att visa eller gömma markören medan du tar skärmdump.

Skärmskydd verktyg på skärmen. Det innehåller några nycklar för att göra skärmdump-arbetsflödet mycket snabbare

5. Gör grundläggande uppgifter med bilder

Klargöra ger många möjligheter att manipulera bilder: rotera, skörda, använda grundläggande anteckningsverktyg, ändra storlek på bilder och bildduk. 

För att rotera bilden klickar du på Redigera> Rotera bild.

Rotera en bild i Clarify

För att beskära bilden, klicka på Redigera> Beskär bild. Klicka och dra över det område du vill behålla och tryck på Lämna tillbaka nyckel-.

Beskär en bild i Clarify

Du kan välja mellan ett antal anteckningsverktyg. Välj bilden och klicka på typ av annoteringsverktyg som du vill använda från formateringsverktygsfältet: Linjeverktyg, Fyrkantigt verktyg, Cirkelverktyg, Sekvensnummereringsverktyg (du kan anpassa startsekvensen), Textverktyg och Blur verktyg.

Typ av radannonseringsverktyg i Clarify

Klargöra har tre alternativ för att ändra storlek på bilder. Den har fyra handtag runt sidor av bildredigeraren. Klicka och dra några av dessa handtag för att ändra målarens storlek. Du kan inte beskära en bild med dessa dukhandtag. 

Dra och håll ned Alternativ nyckeln till att ändra storlek på alla sidor av duken lika.

Ändra storlek på duk av en bild genom handtag

Använd handtaget för att ändra bildformatet längst ned till höger. Klicka och dra det här handtaget för att ändra storlek på bilden. Tryck och håll ner Alternativ nyckeln till att ändra storlek på bilden i steg om 10%.

Ändra storlek på bilden genom ett handtag som ligger längst ned till höger

För noggrann kontroll över bildstorleken klickar du primärt på stegbilden och väljer Ändra storlek på bild ... . Om steget har flera bilder måste du välja en viss bild och sedan ändra storlek på dem via en kontextuell meny.

Ändra storlek på bilden via en snabbmeny 

6. Skapa understeg eller nestningssteg

Klargöra har möjlighet att skapa understeg. Ett understeg är inryckt under modersteget och kan vara en nivå djupt. När du exporterar dokumentet visas ett under-stegs kakel på ett annat sätt i en liten teckenstorlek, substegsnummerering (om du aktiverar det). Först skapa det vanliga steget som beskrivits tidigare.

Välj det steg som du vill göra ett delsteg. Gå till Dokument> Flytta steg menyn och flytta steget höger att indraga det. Flytta delsteget upp eller ner att organisera det tekniska dokumentet, efter behov.

Skapa understeg i Clarify

7. Automatisk numrering av stegen

När det tekniska dokumentet innehåller ett antal steg kan du prefixa dem med ett nummer. Klargöra kommer auto-nummer steg, klicka Dokumentinspektör och kolla Auto-nummer-steg. Alla andra steg kommer automatiskt att prefixeras med siffror.

Auto nummer steg i Clarify

För att utesluta ett steg från att få ett prefix, klicka på Steginspektör och kryssa Exkludera från Auto-nummer. Det steget kommer inte längre att vara prefixat med ett nummer.

Uteslut ett steg i Clarify

Det kan finnas situationer där du inte vill auto-numrera toppnivåerna, men bara substeg. För att göra det, klicka på Steginspektör och kolla Auto-nummer subsystem. Endast substeg har prefix med siffror.

Automatisk antal subsystem i Clarify. Om den här funktionen inte fungerar, är det troligen en bugg

8. Utföra avancerade uppgifter med bilder

Klargöra innehåller några sofistikerade funktioner för att manipulera bilder. Även om dessa funktioner är tillgängliga på andra bildredigerare, har de i Klargöra gör processen med att skapa teknisk dokument mycket snabbare. Om du vill lägga till en ram runt bilder väljer du de steg du vill redigera.

Klicka på Steginspektör och inom Bildinställningar avsnittet ändrar Bildgräns du vill lägga till för bilderna. Du kan välja mellan LinjeBild ram, och Rundade hörn.

Lägg till bildgräns i Clarify. Du kan välja mellan Linje, Bildram och Avrundade hörn

Klargöra kan automatiskt skala bilderna och minska dem om de är för långa eller breda.

Klicka på Dokumentinspektör och kolla Auto-skala bilder. Ställ in max höjd, eller bredd av bilden eller båda.

Skala automatiskt bilder i Clarify utan att behöva en bildredigerare

Att lägga till flera bilder i ett steg är också en tidskrävande process. Klicka på + skylt som ligger bara till sidan av dukhandtaget. 

Ta skärmdumpen, och du hittar dem som ingår i steget.

Att lägga till flera bilder till ett steg är enkelt och utan att fitta runt appar

Om du har konfigurerat Upprepa senaste skärmdumpen du behöver inte störa skärmbildningsverktygen. Bilden läggs strax under den översta bilden, och så vidare.

Lägga till flera bilder i ett enda steg. Om du måste ta skärmdump av samma område flera gånger konfigurerar du snabbtangenten Repeat Last Screenshot

Om du vill ersätta en bild för ett visst steg väljer du den bild du vill ersätta och klickar sedan på Byt ut bild ikonen längst upp till vänster. 

Eller klicka på Byta ut ikonen som ligger bredvid dukhandtaget.

Byt ut bild i Clarify 1. Byt bildikon 2. Byt ikon nära dukhandtag

9. Bädda in en värdfilm i ett steg

Ett tekniskt dokument är lätt att följa om du tar med en video. Med Klargöra Du kan bädda in videor som är värd för videotjänster, till exempel Youtube lätt in i stegen. 

Välj steget, klicka på Steginspektör och ändra Mediatyp från Bild till html.

Byt media typ i steg inspektör från bild till HTML

När du gör det ser du en ruta för att infoga HTML-kod. Gå till Youtube, och kopiera inbäddningskoden för videon. Klick Förhandsvisning för att se förhandsvisningen av HTML.

Klistra in koden i rutan. Välj inbäddningskoden från Youtube-videon

Vissa exportformat kan inte visa HTML för ett steg. Klicka på Bild fliken och lägg till en bild, för den här typen av exportformat. 

Du måste alltid använda bildrepresentationen när du exporterar din Klargöra dokument till Ord (DOCX förlängning).

Lägg till en bild för att visa HTML 

10. Lägg till ankare till steg i HTML-utmatning

Du kan lägga till ankare taggar till steg som kommer att tilldela som id-egenskapen i HTML-utmatning. Detta kan vara användbart för att länka direkt till specifika steg när du delar en Klargöra dokument till webben. 

Om du till exempel anger ankarsnamnet för ett steg till special-steg och om din Klargöra dokumentadress är

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

då kan du länka direkt till steget genom att lägga till # Speciella steg till webbadressen:

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

Om du vill lägga till ankarkoder i ett steg väljer du det steg du vill redigera. Klick Steginspektör och inom Steginställningar sätt ankare namn. 

Använd endast bokstäver, siffror, bindestreck eller understreck när du anbringar ett ankare namn.

Lägg till ankarkoder i steg i Clarify dokument

Obs! Om du inte sätter ett ankare för ett steg då Klargöra kommer automatiskt generera taggar baserat på internt ID vilket Klargöra tilldelar steg när du skapar dem. Dessa ankarkoder kommer att förbli samma varje gång du exporterar Klargöra dokumentera.

11. Exportera och dela Clarify-dokumentet

Gå till Förtydliga> Inställningar och klicka Dela med sig. Klicka på + knappen och välj delningskonto för exportmål. Ett delningskonto kan exporteras till Clarify-it.com, Wordpress och Evernote. Du kan också exportera din Klargöra dokument som PDF, HTML och Word.

För att dela konton måste du ha ett konto och ett godkännande. För PDF, HTML, välj eller anpassa mallen som du vill använda varje gång.

Skapa dela konton i klargöra

Du kan anpassa mallen för PDF, HTML. E-post och Word. I HTML-mall kan du välja mellan ett antal mallar: Grundläggande, Chrome, Corporate, Markdown, Technical och till och med anpassad HTML-mall. 

Välj logotypen och ställ in bildens dimensioner för den här mallen. Klicka på Förhandsvisning knappen för att se mallen som du anpassade.

Anpassa HTML-mall i klargöra

Du kan också anpassa e-postmallen på samma sätt. Eftersom det kommer att använda PDF kan du anpassa PDF-mallen och välja e-postklienten: Apple Mail, Postbox, Outlook eller Airmail. Klicka på Förhandsvisning knappen för att se mallen som du anpassade.

E-postmall i Clarify. Välj den e-postklient du föredrar

Slutsats

Klargöra är en inbyggd app för Windows och Mac att skapa tekniska dokument. Det låter dig skapa mallar så att du kan fokusera på att skapa ett tekniskt dokument utan uppmuntran och hantera flera apps-skärminspelningsverktyg, ordbehandlare och delningsverktyg.

I den här handledningen har jag visat dig steg för steg för att skapa ett tekniskt dokument. Appen innehåller en 14-dagars försök och är tillgänglig för 29,99 dollar. Se prisinformationen för mer information.