Bitte hier klicken, um zu helfen David McMurrey bezahlen für Webhosting:
Spende einen Betrag, den du dir leisten kannst!
Online-Technisches Schreiben bleibt kostenlos.
Hier sind zwei Definitionen von Leitdokumenten:
- Ein Leitfaden ist ein Dokument, eine Veröffentlichung oder eine digitale Ressource, die Schritt-für-Schritt-Anleitungen, Tipps und Informationen bereitstellt, wie man spezifische Aufgaben ausführt, Produkte nutzt oder komplexe Konzepte versteht. Ein Handbuch kann auch Fehlerbehebungsinformationen, Links zu verwandten Gemeinschaften und Links zu verwandter Forschung enthalten.
- Anderswo, in der Regierungswelt, Leitdokumente oder Leitfaden Dokumente sollen der Öffentlichkeit hilfreiche Informationen bereitstellen, wie zum Beispiel die Verpflichtungen unter einem bestehenden Gesetz oder einer Verordnung zu klären oder Informationen über die Verfahren der Behörde zu liefern. Mit anderen Worten, sie übersetzen die komplexe Rechtssprache administrativer Regeln, um es der Öffentlichkeit zu ermöglichen, diese Regeln einzuhalten.
Leitfäden Dokumente
Ein Leitfaden-Dokument ist im Kern eine Reihe von Anweisungen, jedoch mit anderen Ressourcen, um es breiter nützlich zu machen.
Überprüfung des Kapitels über Anweisungen, Sie sehen, dass die Anweisungen von einem Abschnitt, der die benötigte Ausrüstung und Versorgung detailliert, und von einem Abschnitt, der die Verfahrensschritte oft in nummerierter vertikaler Listenform detailliert, xxed werden. Fügen Sie einen Abschnitt wie diesen in Ihr Handbuch—ein, aber das ist noch nicht alles!
Leitfäden Grundlagen: Anweisungen
Die ersten sechs Elemente in der folgenden Liste von Überschriften sehen aus wie jede gewöhnliche Anleitung—aber der Rest nicht!
Wählen Sie den richtigen Standort
Wählen Sie die Größe des Gartens
Wähle Gemüse
Bestimmen Sie, wo und wann Sie pflanzen sollten.
Bestimme, wann was gepflanzt werden soll
Gestalte den Gartenplan
Gartengeräte erwerben
U.S. Gemüseanbauzonen
Durchschnittliche saisonale Temperaturen in den USA
Häufige Schädlinge im Gemüseanbau und deren Bekämpfung
Online Gemüseanbau-Ressourcen
Gemüseanbau-Foren und -Gemeinschaften
Adaptiert mit Erlaubnis von Gemüsegarten für Anfänger: Der vollständige Leitfaden
Selbst die Länge und Detailgenauigkeit der ersten sechs Punkte ist größer, als man in einem typischen zweiseitigen Satz von Anweisungen erwarten würde, ganz zu schweigen von den hübschen dekorativen Bildern.
Hier ist eine weitere Liste von Überschriften, die auf ein viel längeres Dokument hindeuten als ein ein- oder zweiseitiger Satz von Anweisungen:
Auswahl des Gartenstandorts
Auswahl der Ernte
Gartenplan: Standort, Rotation
Bodenbearbeitung
Befruchtung
Pflanzen
Gießen
Unkrautbekämpfung
Mulchen
Schädlingsbekämpfung
Ernte
Gartenarbeit Do's und Don'ts
Mit Genehmigung angepasst von Texas Gartenführer für Gemüseanbau zu Hause Joseph Masabn, Texas A&M AgriLife.
Leitfaden Ergänzungen: Extras
Was ein Satz von Anweisungen zu einem Leitfaden macht, sind die in diesem Abschnitt besprochenen Ergänzungen.
Theorie, Konzeptuelle Informationen
Bildbearbeitungs- und Manipulationssoftware trägt eine ernsthafte Verantwortung, Farbkurven, Ebenenmasken und Kanäle zu erklären. Die wunderbare kostenlose Bildsoftware GIMP bietet einige gute Erklärungen zu den Konzepten bei Basis Farbkurven:
|
Pixel Farben — von Pat David Denke daran, dass jeder Pixel durch eine Kombination aus 3 Farben dargestellt wird: Rot, Grün und Blau. In GIMP (derzeit bei 8-Bit) bedeutet das, dass jede RGB-Farbe einen Wert von 0 bis 255 haben kann, und das Kombinieren dieser drei Farben mit unterschiedlichen Intensitäten in jedem Kanal ergibt alle Farben, die du in deinem Bild sehen kannst. Wenn alle drei Kanäle den Wert 255 haben, wird die resultierende Farbe reinweiß sein. Wenn alle drei Kanäle den Wert 0 haben, wird die resultierende Farbe rein schwarz sein. Wenn alle drei Kanäle den gleichen Wert haben, dann erhält man einen Grauton (128,128,128 wäre beispielsweise eine mittlere Graufarbe). Hier sind einige Farbeinstellungen in GIMP: 
Wie Sie sehen können, gibt es mehr Blau als alles andere (es ist schließlich ein bläulicher Pixel), gefolgt von Grün und dann einem Hauch von Rot. Wenn wir die Werte jedes Kanals ändern, aber das Verhältnis zwischen Rot, Grün und Blau gleich halten, würden wir die gleiche Farbe beibehalten und den Pixel einfach um einen bestimmten Betrag aufhellen oder abdunkeln. |
Fehlerbehebungsinformationen
Fehlerbehebungsinformationen werden oft in einem Versuch-das, Versuch-jenes Rahmenformat strukturiert.
|
Problem: Der Power-Knopf startet den Computer nicht. ▢ Lösung 1: Wenn Ihr Computer nicht startet, überprüfen Sie zunächst das Netzkabel, um zu bestätigen, dass es sicher mit der Rückseite des Computergehäuses und der Steckdose verbunden ist. ▢ Lösung 1: Wenn Ihr Computer nicht startet, überprüfen Sie zuerst das Netzkabel, um sicherzustellen, dass es fest mit dem Rücken des Computergehäuses und der Steckdose verbunden ist. ▢ Lösung 2: Wenn es in eine Steckdose eingesteckt ist, stellen Sie sicher, dass es sich um eine funktionierende Steckdose handelt. Um Ihre Steckdose zu überprüfen, können Sie ein anderes elektrisches Gerät, wie eine Lampe, einstecken. ▢ Lösung 3: Wenn der Computer an ein Überspannungsschutzgerät angeschlossen ist, überprüfen Sie, ob es eingeschaltet ist. Möglicherweise müssen Sie das Überspannungsschutzgerät zurücksetzen, indem Sie es ausschalten und dann wieder einschalten. Sie können auch eine Lampe oder ein anderes Gerät an das Überspannungsschutzgerät anschließen, um zu überprüfen, ob es korrekt funktioniert. ▢ Lösung 4: Wenn Sie einen Laptop verwenden, ist der Akku möglicherweise nicht aufgeladen. Stecken Sie das Netzteil in die Steckdose und versuchen Sie dann, den Laptop einzuschalten. Wenn er immer noch nicht startet, müssen Sie möglicherweise ein paar Minuten warten und es erneut versuchen. |
Quelle: Adaptiert mit Genehmigung von Computer Grundlagen - Grundlagen der Fehlerbehebungstechniken
Gemeinschaften und Foren
Verwandte Ressourcen
KI-Eingabeaufforderungen für Leitfäden
Checklisten, die typischerweise ungelesen bleiben, können mit einigen Anpassungen als Quelle für KI-Inputs verwendet werden. Kopiere das Folgende, füge es in ein KI-System wie Googles Gemini ein und prüfe, was du vielleicht übersehen hast.
Hinweis: Alle Verweise auf den Inhalt, das Format, den Stil von Techdocs oder dessen Komponenten sind in der Online-Technik-Schreibbuch.
Bald erhältlich!
Leitdokumente
Wie hier dargestellt, übersetzen Richtliniendokumente Verwaltungsregeln in Informationen, die von gewöhnlichen, nicht rechtlichen Personen gelesen werden können.
- Eine Verwaltungsregel ist geprägt von stark juristischer Sprache und oft technischer Sprache. Hier ist ein Beispielauszug: UNTERKAPITEL B: FREILUFTVERBRENNUNG §§111.201, 111.203, 111.205, 111.207, 111.209, 111.211, 111.213, 111.215, 111.217, 111.219, 111.221. Texas-Kommission für Umweltqualität, Wirksam seit 2017.
- Ein Leitdokument hingegen versucht, die wesentlichen Punkte der Verwaltungsvorschrift in verständlicher Sprache zu erklären, um dem normalen Bürger zu ermöglichen, die Vorschrift einzuhalten. Hier ist ein Beispielauszug: Freilufteinschätzung. Texas-Kommission für Umweltqualität, 2015.
Projektmöglichkeiten
Wenn Sie eine mutige Seele sind, die ein Leitdokument schreiben möchte, versuchen Sie, eine Verwaltungsvorschrift zu finden, die glücklicherweise kurz ist—unter 10 Seiten. Hier sind einige Möglichkeiten:
Bitte wählen Sie aus und schreiben Sie über eines der folgenden:
- Kapitel 361. Gesetz über die Beseitigung von festen Abfällen. Diese Regelung betrifft die Vorschriften zu gebrauchten Reifen oder Asbest in Texas.
- Verwertung von AltölTexas-Kommission für Umweltqualität
- Verwaltung von gebrauchten oder Altreifen
- Kapitel 2201, Boxen. Darum geht es nicht um Pappe!
- Kapitel 2100, Lizenzierung, Registrierung und Betrieb (der Friseurläden)
- Kapitel 5300, Ehe- und Familientherapie
Leitfadendokumenten-Design
Einige Vorschläge zum Schreiben eines Leitfadens:
- Denke daran, die tatsächliche Regel als Anhang einzufügen. Einige Regel-Dokumente können recht lang sein. Du kannst einfach die Abschnitte der Regeln kopieren, die in deinen Hinweisen behandelt werden.
- Fügen Sie so viele der Anhänge ein, wie es praktisch ist—insbesondere die, die "Standardtexte" sind.
- Gestalten Sie Ihr Leitfadendokument mit einer Grafik, Überschriften und Unterüberschriften sowie weiteren Merkmalen, die es wie ein echtes Leitfadendokument erscheinen lassen.
KI-Aufforderungen für Leitdokumente
Checklisten, die typischerweise ungelesen bleiben, können mit einigen Modifikationen als Quelle für KI-Prompts verwendet werden. Kopiere das Folgende, füge es in ein KI-System wie Googles Gemini ein und schaue, was du möglicherweise übersehen hast.
Hinweis: Alle Verweise auf den Inhalt, das Format und den Stil von TechDocs oder seinen Komponenten sind in der Online-Technikschreibbuch.
Kommt bald!
Verwandte Informationen
Leitdokumente. U.S. Landwirtschaftsministerium
HHS Leitfadenportal. U.S. Gesundheitsministerium & Soziale Dienste
Ich würde Ihre Gedanken, Reaktionen und Kritiken zu diesem Kapitel schätzen: Ihre Antwort—David McMurrey.
