Maken eindgebruiker documentatie: Filosofieën en Resourcess


Dit instructable zal u helpen doordat u:

  • Hebben een duidelijk inzicht in het belang van goede documentatie praktijken, normen en beginselen
  • Weten welke documentatie zal werken voor u! Een eindgebruiker hebben gericht mentaliteit
  • Heb een set van documentatie richtsnoeren te volgen met behulp van Camtasia
  • Hebben sommige Camtasia tips en tweaks te volgen
  • Meesters van de documentatie worden en nooit zorgen over documentatie, opnieuw!

Onderwerpen voor revisie

  • Meerdere vormen van vertegenwoordiging (verschillende leerstijlen)
  • Duidelijkheid en consistentie - Houd het eenvoudig en het belang van de standaardsjablonen
  • Tekst vs. Graphics - het debat
  • Gegevensstroomdiagrammen - stroomschema's, de IFD en processtromen-stroom of geen stroom, dat is de vraag?
  • Het betrekken van de eindgebruiker
  • Dat gebeurt wat moet ik nu doen?-opleiding/Follow up en onderhoud
  • OP het WEB?... welke hulpmiddelen zijn nodig en hoe kan dit worden vereenvoudigd?

Gerelateerde Artikelen

Uw eigen bevel Linux in 5 minuten

Uw eigen bevel Linux in 5 minuten

Interessante vordering, juiste? Heb je ooit wilde verspreid het woord over uw klein script dat verbazingwekkende dingen terug naar de Gemeenschap doet? Heb je ooit gedacht dat uw script ook hacky is te gaan daar of zelfs de output of manier om het te
Linux tips II

Linux tips II

Zullen we verschillende distributies Toon web server instellen met inbegrip van de installatie en vervolgens enkele andere tips.1 terminals2. debian net installeren instelling.3. debian te installeren.4. fedora net installeren installatie5. fedora in
Aan de slag met de TI MSP430-gcc en de MSP430 Launchpad op Linux

Aan de slag met de TI MSP430-gcc en de MSP430 Launchpad op Linux

In dit Instructable zal ik u tonen hoe aan de slag met de TI msp430-gcc toolchain op Linux, specifiek Lubuntu. Msp430-gcc vrijgegeven TI officieel na de overname van de open sourcegemeenschap. [Hopelijk] Hierdoor zal er ondersteuning voor de nieuwste
Deurbel FamilyMart

Deurbel FamilyMart

FamilyMart is een van de meest grootste supermarkt-keten in Azië. Ze gebruiken een karakteristiek deur klokkenspel thats een Japanse melodie genaamd melodie klokkenspel No.1-Daiseikyou (メロディーチャイム第1番・大盛況; Daiseikyou vertaalt naar "grote succes/voorspo
Huisgemaakte 7 segment display klok

Huisgemaakte 7 segment display klok

ik bouwde dit voor mijn vriendin, en het samengevoegd tot een Cocos schil. De kern van het is er een PIC16F727 in TQFP pakket, en een gemeenschappelijke weergave van de anode. Ik kreeg het display van mijn ex teamleider, en aangezien deze toont soort
Hoe het bouwen van de snelste quadcopter in 3 uur

Hoe het bouwen van de snelste quadcopter in 3 uur

Ongeveer een jaar geleden instellen ik op mijn reis naar quadcopter piloot. Ik heb 5 maanden onderzoek, talloze websites bezoeken, een ton van video's kijken en een heleboel noob vragen op het forum posten totdat ik merkte dat ik klaar om te bouwen v
Schieten voor een functie van de Homepage: Timelapse en multi-blootstelling Fotografie DIY-Hoe (maken of uw eigen code schrijven!)

Schieten voor een functie van de Homepage: Timelapse en multi-blootstelling Fotografie DIY-Hoe (maken of uw eigen code schrijven!)

Wat ik leuk vindt aan Instructables is het foto-centric: het eerste wat je ziet bij het maken van een nieuwe Instructable is "Voeg afbeeldingen", voordat een tekstvermelding dialoogvenster verschijnt! Foto's zijn in de wereld waarin die we vanda
Maken van rubberen eenden meer awesome (met Lego & Sugru)

Maken van rubberen eenden meer awesome (met Lego & Sugru)

Onze kappen ruimte (Leicester Hackspace) heeft gekregen een partij van Sugru voor ons om van alles en nog wat wij dat nodig achten. Ik kreeg geïnspireerd door de website Sugru om een te geven van mijn vrouw veel rubberen eenden een beetje van een mak
The Ultimate Guide to Chiptunes maken op de Game Boy!

The Ultimate Guide to Chiptunes maken op de Game Boy!

Nieuw voor de Gameboy 'Chiptune' scène?  Of misschien uw nog proberen om naar de onderkant van wat deze hele Chiptune ding is?  Ongeacht uw situatie, tegen het einde van dit Instructable, beloof ik dat u zult een pro!Relatief nieuw voor de 'LSDJ'-scè
Hoe om uw spel te maken

Hoe om uw spel te maken

Heb je de drang om je eigen tabletop spel te maken? Heb je een idee dat u altijd al wilde proberen of u vol ideeën voor games bent maar niet zeker weet waar te beginnen? Wil je het goed genoeg dat uw familie en vrienden zal willen spelen? Top tafelsp
Sculptuur documentatie

Sculptuur documentatie

dit is een documentatie van de oprichting van mijn sculpture, "Een gemakkelijke oplossing".   Ik maak kunst en structuren die het analyseren van de relatie tussen menselijke ontwikkeling en de wijziging van biologische systemen.  Wilt u meer wet
Ember Printer: Maken en afdrukken modellen met behulp van ShapeJS

Ember Printer: Maken en afdrukken modellen met behulp van ShapeJS

ShapeJS is dat een voxel-based scripting tool gemaakt door Shapeways die u kunt gebruiken bij het maken van afdrukbare modellen met behulp van Javascript. Alles van shapeways uitvoer in. X3db formaat, maar met behulp van conversie tools, kunt u het b
Proberen mijn hand op: het maken van de mal en gieten met siliconen RTV [Pittsburgh Tech Shop]

Proberen mijn hand op: het maken van de mal en gieten met siliconen RTV [Pittsburgh Tech Shop]

vandaag bij de Pittsburgh Tech Shop, nam ik een klasse in de mal maken en gieten. Dit is een geweldige techniek voor het maken van meerdere exemplaren van een stuk uit hars. Het is gebruikt in beeldhouwen, prop maken, make-up voor speciale effecten,
Computers maken sneller!

Computers maken sneller!

We weten allemaal dat onze personal computer (PC) traag en niet reageert soms kan worden. Ik heb een gids bij diegenen die het nodig om te doen een fundamentele opschonen van hun Windows 8.1, (en in sommige gevallen), windows 8 en 7 PC.Maak je geen z