Klik hier om te helpen David McMurrey betaal voor webhosting:
Doneer elk klein bedrag dat je kunt!
Online technisch schrijven blijft gratis.
Hier zijn twee definities van gidsdocumenten:
- Een gids is een document, publicatie of digitale bron die stapsgewijze instructies, tips en informatie biedt over hoe specifieke taken uit te voeren, producten te gebruiken of complexe concepten te begrijpen. Een gids kan ook probleemoplossende informatie, links naar gerelateerde gemeenschappen en links naar gerelateerd onderzoek bevatten.
- Elders, in de regeringswereld, gidsdocumenten, of leiding documenten zijn bedoeld om nuttige informatie aan het publiek te bieden, zoals het verduidelijken van verplichtingen onder een bestaande wet of regeling, of het geven van informatie over de procedures van de instantie. Met andere woorden, zij vertalen de complexe juridische taal van administratieve regels zodat het publiek zich aan deze regels kan houden.
Gidsdocumenten
Een gidsdocument is in wezen een set instructies, maar met andere middelen om het breder bruikbaar te maken.
Het herzien van het hoofdstuk over instructies, je ziet dat instructies worden aangevuld door een sectie die de benodigde apparatuur en materialen beschrijft en door een sectie die de procedurele stappen detailleert, vaak in genummerde verticale lijstformaat. Voeg een sectie als deze toe in je gidsdocument—maar dat is nog niet alles!
Gids Fundamenten: Instructies
De eerste zes items in de volgende lijst met kopjes lijken op een gewone set instructies—maar de rest niet!
Kies de Juiste Locatie
Kies de Grootte van de Tuin
Kies Groenten
Bepaal Waar en Wanneer te Planten
Bepaal Wanneer te Planten Wat
Ontwerp het Tuinplan
Tuinwerkzaamheden Gereedschap Verwerven
U.S. Groentetuin Zones
Gemiddelde Seizoensgebonden Temperaturen in de VS
Veelvoorkomende Plantenbedrijf Plagen en Bestrijding
Online Groenten Tuinieren Hulpmiddelen
Groentetuingroepen en Gemeenschappen
Aangepast met toestemming van Groenten tuinieren voor beginners: De complete gids
Zelfs de lengte en detail van de eerste zes items is groter dan je zou verwachten in een gewoon tweepagina-instructieset, om nog maar te zwijgen van de mooie decoratieve afbeeldingen.
Hier is nog een lijst met koppen die een veel langer document voorspellen dan een set instructies van één of twee pagina's:
Tuinlocatie Keuze
Gewasselectie
Tuinplan: Locatie, Rotatie
Bodemvoorbereiding
Bevruchting
Planten
Water geven
Onkruidbestrijding
Mulchen
Ongediertebestrijding
Oogsten
Tuinieren Do's en Don'ts
Aangepast met toestemming van Texas Thuis Groenten Tuinieren Gids Joseph Masabn, Texas A&M AgriLife.
Gids Supplementen: Extra's
Wat een set instructies tot een gids maakt, zijn de aanvullingen die in de sectie worden besproken.
Theorie, Conceptuele Informatie
Afbeeldingcreatie en manipulatie software heeft een serieuze verantwoordelijkheid om kleurenlijnen, lagenmaskers, kanalen uit te leggen. De geweldige gratis afbeeldingssoftware GIMP heeft enkele goede uitleg over concepten op Basis Kleurcurven:
|
Pixel Kleuren — door Pat David Vergeet niet, elke pixel wordt weergegeven door een combinatie van 3 kleuren: Rood, Groen en Blauw. In GIMP (momenteel op 8-bit) betekent dat dat elke RGB-kleur een waarde kan hebben van 0–255, en het combineren van deze drie kleuren met variërende niveaus in elk kanaal zal resulteren in alle kleuren die je in je afbeelding kunt zien. Als alle drie de kanalen een waarde van 255 hebben, dan zal de resulterende kleur puur wit zijn. Als alle drie de kanalen een waarde van 0 hebben, dan zal de resulterende kleur puur zwart zijn. Als alle drie de kanalen dezelfde waarde hebben, dan krijg je een tint grijs (128,128,128 zou bijvoorbeeld een midden grijs kleur zijn). Hier zijn enkele kleurinstellingen in GIMP: 
Zoals je kunt zien, is er meer blauw dan enige andere kleur (het is tenslotte een blauwachtige pixel), gevolgd door groen, en dan een vleugje rood. Als we de waarden van elke kanaal zouden veranderen, maar de verhouding tussen Rood, Groen en Blauw gelijk zouden houden, zouden we dezelfde kleur behouden en de pixel gewoon met een bepaalde hoeveelheid lichter of donkerder maken. |
Probleemoplossingsinformatie
Probleemoplossingsinformatie is vaak opgemaakt als een probeer-dit, probeer-dat structuur.
|
Probleem: Aan/uit-knop start computer niet op ▢ Oplossing 1: Als je computer niet opstart, begin dan met het controleren van de stroomkabel om te bevestigen dat deze stevig is aangesloten op de achterkant van de computerbehuizing en het stopcontact. ▢ Oplossing 1: Als je computer niet opstart, begin dan met het controleren van de stroomkabel om te bevestigen dat deze stevig is aangesloten op de achterkant van de computerkast en het stopcontact. ▢ Oplossing 2: Als het in een stopcontact is gestoken, zorg er dan voor dat het een werkend stopcontact is. Om je stopcontact te controleren, kun je een ander elektrisch apparaat inpluggen, zoals een lamp. ▢ Oplossing 3: Als de computer is aangesloten op een overspanningsbeveiliging, controleer dan of deze is ingeschakeld. Mogelijk moet je de overspanningsbeveiliging resetten door deze uit en weer aan te zetten. Je kunt ook een lamp of een ander apparaat in de overspanningsbeveiliging aansluiten om te controleren of deze correct werkt. ▢ Oplossing 4: Als je een laptop gebruikt, is de batterij mogelijk niet opgeladen. Steek de AC-adapter in het stopcontact en probeer de laptop aan te zetten. Als hij nog steeds niet opstart, moet je misschien een paar minuten wachten en het opnieuw proberen. |
Bron: Aangepast met toestemming van Computer Basics - Basis Probleemoplossingstechnieken
Gemeenschappen en Forums
Gerelateerde bronnen
AI-oproepen voor Gidsdocumenten
Checklist, die doorgaans ongelezen blijven, kunnen als bron voor AI-opdrachten worden gebruikt met enige aanpassing. Kopieer het volgende, plak het in een AI-systeem zoals Google’s Gemini, en kijk wat je mogelijk hebt gemist.
Opmerking: Alle verwijzingen naar de inhoud, indeling, stijl van techdocs of zijn componenten zijn te vinden in de online technisch schrijfboek.
komt binnenkort!
Begeleidingsdocumenten
Zoals hier gepresenteerd, vertalen leidende documenten administratieve regels naar informatie die leesbaar is voor gewone niet-juridische mensen.
- Een administratieve regel kenmerkt zich door sterk juridisch taalgebruik en vaak technisch taalgebruik. Hier is een voorbeeldfragment: SUBHOOFDSTUK B: BUITEN BRANDEN §§111.201, 111.203, 111.205, 111.207, 111.209, 111.211, 111.213, 111.215, 111.217, 111.219, 111.221. Texas Commissie voor Milieu Kwaliteit, Van kracht 2017.
- Een leid document probeert daarentegen de belangrijkste punten in de administratieve regel in toegankelijke taal uit te leggen, zodat de gewone burger aan de regel kan voldoen. Hier is een voorbeeldfragment: Buitenverbranding. Texas Commissie voor Milieu-kwaliteit, 2015.
Project mogelijkheden
Als je een dappere ziel bent die een leidraaddocument wil schrijven, probeer dan een administratieve regel te vinden die genadig kort is—onder de 10 pagina's. Hier zijn een paar mogelijkheden:
Overweeg om te kiezen en te schrijven over een van deze:
- Hoofdstuk 361. Wet op de Afvalverwerking. Dit betreft de regels voor gebruikte autobanden of asbest in Texas.
- Gebruik van Recycling van Olie. Texas Commissie voor Milieukwaliteit
- Beheer van gebruikte of afgedankte banden
- Hoofdstuk 2201, Boksen. Dit gaat niet over karton!
- Hoofdstuk 2100, Licenties, Registratie en Operatie (of kapperszaken)
- Hoofdstuk 5300, Huwelijk engezins therapie
Ontwerp van het begeleidingdocument
Enkele suggesties voor het schrijven van een richtlijndocument:
- Vergeet niet om de daadwerkelijke regel als een bijlage mee te kopiëren. Sommige regelsdocumenten kunnen vrij lang zijn. Je kunt gewoon de secties van de regels kopiëren die in je begeleiding worden behandeld.
- Neem zoveel mogelijk van de bijlagen op die praktisch zijn—in het bijzonder de degenen die "standaardtekst" zijn.
- Kleed uw richtlijndocument aan met een grafiek, koppen en subkoppen, en andere kenmerken die het de uitstraling van een authentiek richtlijndocument zullen geven.
AI-aanwijzingen voor richtlijndocumenten
Checklist, die doorgaans ongelezen blijven, kunnen als bron voor AI-prompts worden gebruikt met enige aanpassing. Kopieer het volgende, plak het in een AI-systeem zoals Google's Gemini en kijk wat je misschien gemist hebt.
Opmerking: Alle verwijzingen naar de inhoud, opmaak, stijl van techdocs of zijn componenten zijn te vinden in de online technisch schrijfboek.
komt eraan!
Gerelateerde Informatie
Begeleidingsdocumenten. Amerikaanse Ministerie van Landbouw
HHS Richtlijnportaal. U.S. Ministerie van Gezondheid en Sociale Zaken
Ik waardeer uw gedachten, reacties, en kritiek over dit hoofdstuk: je antwoord—David McMurrey.
