Att skapa slutanvändaren dokumentation: Filosofier och Resourcess



Detta instructable kommer att hjälpa dig genom att du kan:

  • Har en klar förståelse av vikten av bra dokumentation praxis, standarder och principer
  • Vet vilken dokumentation fungerar för dig! En slutanvändare har fokuserat tänkesätt
  • Har en uppsättning av dokumentation riktlinjer att följa med Camtasia
  • Har några Camtasia tips och tweaks för att följa
  • Bli dokumentation masters och oroa aldrig om dokumentation, igen!

Ämnen för granskning

  • Flera former av representation (olika inlärningsstilar)
  • Tydlighet och konsekvens, hålla det enkelt och vikten av standardmallar
  • Text vs. grafik - debatten
  • Flödesdiagram - flödesscheman, IFDS och processflöden-flöde eller inte flöde, det är frågan?
  • Engagera dig slutanvändaren
  • Det är gjort vad gör jag nu?-utbildning/uppföljning och underhåll
  • ATT webben?... vilka verktyg behövs och hur kan det förenklas?
Se Steg
Relaterade Ämnen

Att skapa IoT enheter med ESP8266 och PubNub

Om du inte hade hört, är internet saker kungen av en stor sak. Snarare än att tråka ut er med förutsägelser om hur många miljarder enheter ansluts under nästa år, ska jag visa dig hur du enkelt skapar en IoT-enhet med hjälp av awesome ESP8266 WiFi mo...

Att skapa verktygshandtag av 3D-utskrift och gjutning

Som en del av ett personligt projekt, jag utvecklat en metod för att skapa anpassade verktygshandtag för personer med hand medicinska frågor. Processen består i att skapa en gjutform gjutning med en vridbar och utbytbara slutet enhet (för montering o...

Är du en LaTeX fetishist? Att skapa en skjorta med LaTeX och Lumi Inkodye

den andra Lumi instructable från dingfabrik skapades med den fantastiska gratis typesetting programvara LaTeX (se www.tug.org för mer information)Jag använde följande källkoden till skapa PDF med skylten "LaTeX fetishist":\documentclass{article}...

Att skapa hjälmar och rustningar från videospel för nöje och stora vinster!

Detta Instructable kommer att presentera min något märklig metod för att skapa kopior av hjälmar och rustningar från TV-spel. Visserligen är jag inte världens största skulptör, och för att kompensera för min brist på skicklighet i detta område, har j...

Med hjälp av koppar bandet att skapa en Digital urval Pad

detta är delvis mig dela denna teknik, och delvis mig lära sig använda Instructables. Om det finns problem med min dokumentation av tekniken eller min användning av Instructables, låt mig veta i kommentarerna - tack!Jag behövde en lång rad av växlar...

ShowBox - skapa din egen gata scenen och sittplatser

ShowBox är tillfälliga gatan möbler, scenen, spelområdet och inspirerande zon tillverkade av enkla, lättillgängliga, lågteknologiska material. Skapad som en installation för marknaden gatan Prototyping Festival, en tredagars street festival i San Fra...

Guide till att skapa ett Storyboard

detta instructable är en guide på hur man skapar en storyboard. Detta är en ganska enkel process, och allt som krävs är lite kul och fantasi. Det finns många metoder för att skapa ett storyboard, men detta instructable visar bara två av dessa. En är...

Att skapa en sömlös vektor mönster i Adobe Illustrator

Att skapa en sömlös mönster i Illustrator kan verka som en utmaning. Men med dessa få enkla steg, du bör vara på väg att göra mönster för allt från iPhone bakgrundsbilder till anpassade mallar!För detta Instructable kommer jag att använda den vektor...

Tjäna EXTRAPENGAR att skapa häftiga klistermärken i Telegram

Detta instructable visar dig hur du skapar och publicerar klistermärken i Telegram från grunden.Först och främst ska du kommer att behöva:Dator med IllustratorPappersarkPenna, penna eller markörKamera/skannerTelegram webbversionKreativa marknaden pra...

Fantastiskt sätt att använda en Dremel VersaTip och VersaFlame

omSanta förde dig en Dremel VersaTip eller VersaFlame till jul, är chansen du inte kan vänta att börja använda dem. Här är en mycket listig sätt att använda din nya Dremel verktyg för att skapa woodburnt konst för en fondvägg. Allt du behöver är ett...

Att skapa Bookhuddle.com, en webbplats för att upptäcka, organisera och dela bokinformation

detta inlägg beskriver de olika stegen i att skapa och lanserar Bookhuddle.com, en webbplats syftar till att hjälpa läsarna att upptäcka, organisera och dela informationen.Steg som beskrivs här gäller utvecklingen av andra webbplatser.Steg 1: Komma m...

Att skapa en enkel 3D-modell på Fusion 360 och skapa en verktygsväg MYDIYCNC

Hej därTory på MyDIYCNC här. Idag vill jag visa dig hur du använder en mycket användbar bit av programvara från Autodesk kallas: Fusion 360. Med denna programvara kan du skapa enkla 3D-modeller till avancerade och komplexa 3D-modeller.Vad jag hoppas...

Att skapa ett universitet Monument och replika brons

2008, min far och jag fick i uppdrag att skapa en 14' höga monument av en cougar maskot för Washington State University. Vi har också skapat tre mindre storlek brons repliker av monumentet att sälja till alumni och fans.I detta instructable jag komme...

Att skapa pedagogiska elektroniska pussel med Circuitscribe kit och 123D's Circuitscribe redaktör

(Obs-detta är en gäst post för Eureka! Fabriken av Chuck Stephens som en del av deras Instructables bygga nattprogram.)Den Circuitscribe kit är ganska cool. Den har elektronisk komponent moduler och ledande bläck pennor som kan användas för att skapa...

Att skapa och hantera en dator game-projekt

jag är en stor anhängare av Indie spelutveckling och älskar att se vad små spel folk gör på sin fritid.När du har skapat ett litet spel försöker många människor göra en större, och då känner att de behöver ett litet team att hjälpa dem längs. Denna k...

Snabbt och enkelt! Använda bläck och en prägling mapp för att skapa en boktryck titt!

Förutom bilden instruktionerna nedan, har jag också laddade upp en video ovan för dig som föredrar videor kontra bild tutorials ovan.Jag älskar att skapa - jag har sedan jag var liten. Sanningsenligt, jag undrar fortfarande där klistra gick och jag t...

Använda Cerat och lös ögonskugga pigment att skapa en awesome läppfärg!

För denna tutorial kommer du att behöva följande material:1. 2 läpp penslar2. glimmer skönhet skimmer 91 Diligence (Mörkbrun)3. glimmer skönhet skimmer 9 Carnival (guld färg)4. glimmer skönhet klart läppbalsam5. 1 pappershandduk6. Foudation eller täc...

Ser ut som din fiende: Skapa tecken på att förvirra, förvåna och parodi!

i detta instructable lär du dig Design kamouflage. I tidigare projekt har jag tillgripits och raffinerade olika tekniker för att härma regeringen eller corporate skyltning. Med hjälp av de metoder som anges i följande steg gör att du kan tillfälligt...

Kombinera MakeyMakey, CircuitScribe och grunden för att skapa konst

Många värdefulla Instructables har skrivits om MakeyMakey, CircuitScribeoch Scratch. När du behärskar grunderna i varje, kan du börja att kombinera dem till ännu mer nyttiga projekt! Detta projekt kombinerar alla tre. Min dotter och jag skapade detta...