Klik hier om te helpen David McMurrey betaal voor webhosting:
Doneer elke kleine bijdrage die je kunt!
Online technisch schrijven blijft gratis.
Hier zijn twee definities van gidsdocumenten:
- Een gids is een document, publicatie of digitale bron die stap-voor-stap 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 overheidswereld, gidsdocumenten, of begeleiding documenten zijn bedoeld om nuttige informatie aan het publiek te bieden, zoals het verduidelijken van verplichtingen onder een bestaande wet of regelgeving, of het verstrekken van informatie over de procedures van de instantie. Met andere woorden, ze vertalen de complexe juridische taal van administratieve regels om het publiek in staat te stellen zich aan die regels te houden.
Gidsdocumenten
Een gidsdocument is in wezen een set instructies, maar met andere bronnen om het breder nuttig te maken.
Het herzien van het hoofdstuk over instructies, je ziet dat instructies worden gevolgd door een sectie met de benodigde uitrusting en materialen en door een sectie met procedurele stappen vaak in genummerde verticale lijstformaat. Neem een sectie zoals deze op in je gidsdocument—maar dat is nog niet alles!
Gids Fundamenten: Instructies
De eerste zes items in de volgende lijst met koppen lijken op een gangbare set van 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 je Wat Plant
Ontwerp het Tuinplan
Tuiniergereedschap Verwerven
U.S. Groentetuin Zones
Gemiddelde Seizoens Temperaturen in de VS
Veelvoorkomende Plantenbedden Ongedierte en Beheersing
Online Groentetuinbronnen
Groenten Tuin Forums en Gemeenschappen
Aangepast met toestemming van Groenten Tuinieren voor Beginners: De Complete Gids
Zelfs de lengte en detail van de eerste zes items zijn groter dan je zou verwachten in een gewone set instructies van twee pagina's, om nog maar te zwijgen van de mooie decoratieve afbeeldingen.
Hier is nog een lijst met kopjes die wijzen op een veel langer document dan een set instructies van één of twee pagina's:
Tuinlocatie Kieswijze
Gewasselectie
Tuinplan: Locatie, Rotatie
Bodemvoorbereiding
Bevruchting
Planten
Bewatering
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 een gids maakt, zijn de aanvullende informatie die in de sectie worden besproken.
Theorie, Conceptuele Informatie
Afbeeldingcreatie- en manipulatiesoftware hebben een ernstige verantwoordelijkheid om kleurcurves, laagmaskers, kanalen uit te leggen. De geweldige gratis afbeeldingssoftware GIMP heeft enkele goede uitleggen van concepten op Basis Kleurcurves:
|
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 dit dat elke RGB-kleur een waarde kan hebben van 0 tot 255, en het combineren van deze drie kleuren met verschillende 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, 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, krijg je een tint van grijs (128,128,128 zou bijvoorbeeld een middelgrijze kleur zijn). Hier zijn enkele kleurinstellingen in GIMP: 
Zoals je kunt zien, is er meer blauw dan wat dan ook (het is tenslotte een blauwachtige pixel), gevolgd door groen, en dan een vleugje rood. Als we de waarden van elk kanaal zouden wijzigen, maar de verhouding tussen Rood, Groen en Blauw hetzelfde hielden, zouden we dezelfde kleur behouden en de pixel gewoon met een bepaalde hoeveelheid verlichten of verduisteren. |
Probleemoplossingsinformatie
Probleemoplossingsinformatie is vaak opgemaakt als een probeer-dit, probeer-dat structuur.
|
Probleem: Aan-uitknop start computer niet op ▢ Oplossing 1: Als je computer niet opstart, begin dan met het controleren van de stroomkabel om te bevestigen dat deze goed 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 goed is aangesloten op de achterkant van de computerbehuizing 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, zoals een lamp, aansluiten. ▢ Oplossing 3: Als de computer is aangesloten op een overspanningsbeveiliger, controleer dan of deze aan staat. Mogelijk moet je de overspanningsbeveiliger resetten door deze uit en weer aan te zetten. Je kunt ook een lamp of een ander apparaat in de overspanningsbeveiliger aansluiten om te controleren of deze goed werkt. ▢ Oplossing 4: Als je een laptop gebruikt, is de batterij mogelijk niet opgeladen. Sluit de AC-adapter aan op het stopcontact en probeer de laptop vervolgens in te schakelen. Als hij nog steeds niet opstart, moet je misschien een paar minuten wachten en het opnieuw proberen. |
Bron: Aangepast met toestemming van Computerbasis - Basisfoutopsporingstechnieken
Gemeenschappen en Fora
Gerelateerde Middelen
AI Prompts voor Gidsdocumenten
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 bent vergeten.
Opmerking: Alle verwijzingen naar de inhoud, het formaat, de stijl van techdocs of zijn componenten zijn te vinden in de online technisch schrijven leerboek.
Binnenkort!
Beleidsdocumenten
Zoals hier gepresenteerd, vertalen richtlijndocumenten administratieve regels naar informatie die leesbaar is voor gewone niet-juridische mensen.
- Een administratieve regel wordt gekenmerkt door zwaar 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 Milieukwaliteit, Van kracht 2017.
- Een leidraaddocument probeert daarentegen de belangrijkste punten in de administratieve regel in begrijpelijke taal uit te leggen, zodat de gewone burger aan de regel kan voldoen. Hier is een voorbeeldfragment: Buitenstoken. Texas Commissie voor Milieukwaliteit, 2015.
Projectmogelijkheden
Als je een dapper genoeg persoon bent om een leidraad op te stellen, probeer dan een administratieve regel te vinden die gelukkig beknopt is—onder de 10 pagina's. Hier zijn enkele mogelijkheden:
Overweeg om een van deze te selecteren en erover te schrijven:
- Hoofdstuk 361. Wet op de Afvalverwijdering. Deze gaat over Texas' regels voor gebruikte banden of asbest.
- Afvalolie Recycling. Texas Commissie voor Milieu Kwaliteit
- Beheer van gebruikte of afgedankte banden
- Hoofdstuk 2201, Boksen. Dit gaat niet over karton!
- Hoofdstuk 2100, Licentie, Registratie en Exploitatie (of kapperszaken)
- Hoofdstuk 5300, Huwelijks- en Gezinstherapie
Ontwerpgids document
Enkele suggesties voor het schrijven van een leidraaddocument:
- Vergeet niet om de werkelijke regel als een bijlage toe te voegen. Sommige regeldocumenten kunnen behoorlijk lang zijn. Je kunt gewoon de secties van de regels kopiëren die in je richtlijnen worden behandeld.
- Neem zoveel mogelijk van de bijlagen op, in het bijzonder de "boilerplate" bijlagen.
- Kleed uw richtlijn document aan met een grafiek, koppen en subkoppen, en andere kenmerken die het eruit laten zien als een echt richtlijn document.
AI Aanwijzingen voor Begeleidingsdocumenten
Checklist, die doorgaans ongelezen blijven, kunnen als bron voor AI-aanwijzingen worden gebruikt met enige aanpassing. Kopieer het volgende, plak het in een AI-systeem zoals Google's Gemini, en kijk wat je misschien hebt gemist.
Opmerking: Alle verwijzingen naar de inhoud, indeling, stijl van techdocs of zijn componenten zijn te vinden in de online technisch schrijven leerboek.
Binnenkort!
Gerelateerde Informatie
Begeleidingsdocumenten. Amerikaanse Ministerie van Landbouw
HHS Richtlijnenportaal. U.S. Ministerie van Volksgezondheid en Sociale Zaken
Ik waardeer uw gedachten, reacties, kritiek op dit hoofdstuk: je reactie—David McMurrey.
