Share
Ett tekniskt dokument är resultatet av att skapa effektiv teknisk användarinformation. Det förklarar antingen hur något fungerar eller hur man använder det. Det kan innebära olika saker för människor i olika roller. Du kan behöva sådan dokumentation för att ombord på nya anställningar, förklara nya funktioner eller som referens för personer som inte är kända inom teknik.
Skriva ett tekniskt dokument behöver ett antal verktyg - en skärmdumps app, en bildredigerare, en ordbehandlare för att skriva instruktioner och verktyg för att dela dokumentet.
Även om detta är det bästa protokollet för att skapa ett tekniskt dokument, verkar det inte rätt när du saknar tid eller behöver uppdatera dem regelbundet.
I denna tvådelade handledning visar jag dig hur du använder Klargöra att skapa enkla och professionella tekniska dokument.
Klargöra ger dig några alternativ att ställa in det tekniska dokumentet enligt dina behov. Gå till Förtydliga> Inställningar.
Du får se tre inställningar: Allmän, Dela med sig, och PDF-mallar. Varje inställning låter dig konfigurera flera parametrar.
Välj de allmänna inställningarna i Clarify-inställningarnaKonfigurera snabbtangenterna för att ta skärmdumpar. Om du vill ändra snabbtangenten klickar du på Ta bort och skriv in den nya snabbtangenten. Om du föredrar stor duk att skriva dina tekniska dokument, växlar du Textredigerare för textredigerare från små till stor.
Klargöra kan du anpassa bildinställningarna, så som du vill. Välj exportformat som PNG eller JPEG (Bra, Bättre, Bäst). Du kan automatiskt generera ALT-taggar för bilderna eller automatiskt skala bilderna, både bredd och höjd, enligt stilguiden.
Välj delningsinställningar i Clarify-inställningar. Klicka på + -knappen för att lägga till ett kontoClarify erbjuder ett antal olika sätt att dela de skapade dokumenten. Du kan exportera för att förtydliga-it.com så att andra kan visa dokument. Du kan exportera dokumentet till anpassningen Wordpress blogg eller .com-blogg eller spara dem som PDF, HTML eller a Ord dokumentera.
Klargöra levereras med fyra grundläggande mallar: Basic, Black and White, Chrome och Corporate.
Om du har några specifika behov kan du skapa din egen PDF-mall. Klicka på + knappen för att skapa en ny anpassad mall.
Anpassa allmänna inställningar för en PDF-mall. Klicka på + för att lägga till en anpassad mallI Allmän flik, anpassa sidstorlek och marginaler, bildjustering, inställningar för innehållsflöde och mer. När du skapar ett PDF-dokument, Klargöra lägger till sidbrytningar på vissa platser. Fastän Klargöra försöker hålla steginnehållet tillsammans, du kan konfigurera dem.
Klicka på Innehållsflöde menyn för att konfigurera sidbrytningsinställningar. Välja Ett steg per sida för att lägga till en sidbrytning efter varje steg.
Välja Passa så mycket som möjligt per sida att lägga så mycket innehåll på sidan som möjligt. Använd CSS för ytterligare kontroll över sidbrytningar.
I rubrikfältet kan du lägga till en Logotyp och anpassa några få variabler. Du kan lägga till variabler som
Accentsconagua
[[Dokument titel]] - Namnet på dokumentet[[Filnamn]] - Namnet på PDF-filen[[Datum]] - Datumet i det format som ditt system använder[[MM / DD / YYYY]] - Månad, dag och årI sidfältet kan du lägga till sidnummer och sidfot. Du kan lägga till variabler som
[[Sidonummer]] - Sidnumret[[Sidonummer]] - Totalt antal sidor
Anpassa teckensnitt och färger i PDF-mallenI Teckensnitt och färger flik, ställa in standard teckensnitt, teckensnittstorlek och färg för rubrik och sidfot, artikelbeskrivning, stegtitel och underrubrikstitel. Om du inte anger ett teckensnitt för ett visst objekt, kommer det att använda Standard typsnitt.
Anpassa CSS i en PDF-mall. Med kunskap om CSS kan du lägga till många variabler De Anpassad CSS fliken kan du göra justeringar av element som inte är tillgängliga i användargränssnittet. PDF mallar i Klargöra fungerar på principen om HTML och CSS. Om du har kunskaper om båda kan du lägga till många variabler till PDF-mall. Till exempel
.stegbehållare (Sidbrytning: alltid)
Denna CSS berättar PDF-generatorn att alltid lägga till en sidbrytning efter ett steg. Du kan också lägga till specifikt typsnitt i PDF-dokumentet genom att lägga till specifika CSS-klasser i dokumentet.
.stegetitel (typsnittstyp: kursiv;font-vikt: lättare;)
Några av de klasser du kan använda är article-beskrivning, steg-titel, steg-behållare, delsteg, och steg-instruktioner. Vid varje steg kan du klicka Förhandsvisning för att se slutprodukten i PDF-mallen.
Klargöra är en inbyggd app för Windows och Mac för 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 appar - skärmfångningsverktyg, ordbehandlare och delningsverktyg.
I den här handledningen har jag visat dig hur du konfigurerar klargöra appen för att skörda maximala fördelar och hur du konfigurerar mallar.
I nästa handledning ger jag ett 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.
