Hier sind zwei Definitionen von Leitdokumenten:
- Ein Leitfaden ist ein Dokument, eine Veröffentlichung oder ein digitales Medium, das schrittweise Anleitungen, Tipps und Informationen bietet, wie man spezifische Aufgaben ausführt, Produkte verwendet oder komplexe Konzepte versteht. Ein Leitfaden 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 bieten, wie zum Beispiel die Klärung von Verpflichtungen gemäß einem bestehenden Gesetz oder einer Vorschrift oder die Bereitstellung von Informationen über die Verfahren der Behörde. Mit anderen Worten, sie übersetzen die komplexe rechtliche Sprache von Verwaltungsregelungen, um der Öffentlichkeit zu ermöglichen, diese Regeln einzuhalten.
Leitdokumente
Ein Leitfaden-Dokument ist im Kern eine Reihe von Anweisungen, aber mit anderen Ressourcen, um es breiter nutzbar zu machen.
Das Überprüfen des Kapitels über Anleitungen, Sie sehen, dass die Anweisungen durch einen Abschnitt ergänzt werden, der die benötigte Ausrüstung und Materialien detailliert und durch einen Abschnitt, der die Verfahrensschritte oft in nummerierter vertikaler Listenform erläutert. Fügen Sie einen Abschnitt wie diesen in Ihr Leitdokument—ein, aber das ist noch nicht alles!
Leitfäden Grundlagen: Anweisungen
Die ersten sechs Punkte in der folgenden Liste von Überschriften sehen aus wie jede gängige Anleitung—aber nicht der Rest!
Wählen Sie den richtigen Standort
Wählen Sie die Größe des Gartens
Gemüse auswählen
Bestimmen Sie, wo und wann Sie pflanzen sollten.
Bestimmen, wann was gepflanzt werden soll
Gestalten Sie den Gartenplan
Gartenwerkzeuge anschaffen
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
Gartenbau-Foren und -Gemeinschaften
Angepasst mit Genehmigung von Gemüsegarten für Anfänger: Der komplette Leitfaden
Selbst die Länge und Detailgenauigkeit der ersten sechs Punkte ist größer, als man es in einem gewöhnlichen 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:
Standortauswahl für den Garten
Auswahl des Feldes
Gartenplan: Standort, Rotation
Bodenbearbeitung
Befruchtung
Pflanzen
Bewässerung
Unkrautkontrolle
Mulchen
Schädlingsbekämpfung
Ernte
Gartenarbeit: Was man tun sollte und was man vermeiden sollte
Mit Genehmigung angepasst von Texas Gemüse-Gartenleitfaden Joseph Masabn, Texas A&M AgriLife.
Leitfaden Ergänzungen: Extras
Was ein Set von Anweisungen zu einem Leitfaden macht, sind die in dem Abschnitt besprochenen Ergänzungen.
Theorie, konzeptionelle Informationen
Bildbearbeitungs- und Manipulationssoftware trägt eine ernsthafte Verantwortung, Farbtöne, Ebenenmasken und Kanäle zu erklären. Die wunderbare kostenlose Bildsoftware GIMP bietet gute Erklärungen zu diesen Konzepten. Basisfarbeneinstellungen:
|
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 (aktuell bei 8-Bit) bedeutet das, dass jede RGB-Farbe einen Wert von 0 bis 255 annehmen kann, und das Mischen 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 einen Wert von 255 haben, dann wird die resultierende Farbe reines Weiß sein. Wenn alle drei Kanäle einen Wert von 0 haben, dann wird die resultierende Farbe reines Schwarz sein. Wenn alle drei Kanäle den gleichen Wert haben, dann bekommst du einen Grauton (128,128,128 wäre zum Beispiel ein mittlerer Grauton). 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 würden, aber das Verhältnis zwischen Rot, Grün und Blau gleich halten, dann würden wir die gleiche Farbe beibehalten und den Pixel nur um einen bestimmten Betrag aufhellen oder abdunkeln. |
Fehlerbehebungsinformationen
Fehlerbehebungsinformationen sind häufig im Format eines "Versuchen Sie dies, versuchen Sie das" Rahmens gestaltet.
|
Problem: Der Power-Knopf startet den Computer nicht. ▢ Lösung 1: Wenn Ihr Computer nicht startet, überprüfen Sie zuerst das Netzkabel, um sicherzustellen, dass es sicher an der Rückseite des Computergehäuses und der Steckdose eingesteckt ist. ▢ Lösung 1: Wenn Ihr Computer nicht startet, überprüfen Sie zunächst das Netzkabel, um sicherzustellen, dass es fest im hinteren Bereich des Computergehäuses und in der Steckdose eingesteckt 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, anschließen. ▢ Lösung 3: Wenn der Computer an einen Überspannungsschutz angeschlossen ist, überprüfen Sie, ob dieser eingeschaltet ist. Möglicherweise müssen Sie den Überspannungsschutz zurücksetzen, indem Sie ihn ausschalten und dann wieder einschalten. Sie können auch eine Lampe oder ein anderes Gerät in den Überspannungsschutz stecken, um zu überprüfen, ob er korrekt funktioniert. ▢ Lösung 4: Wenn Sie einen Laptop verwenden, ist der Akku möglicherweise nicht geladen. Schließen Sie das Netzteil an die Steckdose an 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: Anhand von Erlaubnis angepasst von Computer-Grundlagen - Grundlegende Fehlersuche-Techniken
Gemeinschaften und Foren
Verwandte Ressourcen
KI-Aufforderungen für Handlungsdokumente
Checklisten, die normalerweise ungelesen bleiben, können mit einigen Modifikationen als Quelle für KI-Aufforderungen genutzt werden. Kopiere das Folgende, füge es in ein KI-System wie Googles Gemini ein und sieh nach, was du möglicherweise übersehen hast.
Hinweis: Alle Verweise auf den Inhalt, das Format, den Stil von Techdocs oder dessen Komponenten sind in der Online-Lehrbuch für technische Dokumentation.
Demnächst!
Richtliniendokumente
Wie hier dargestellt, übersetzen Orientierungshilfen Verwaltungsvorschriften in Informationen, die für gewöhnliche nicht juristische Personen verständlich sind.
- Eine Verwaltungsregel ist gekennzeichnet durch stark juristische Sprache und oft technische Sprache. Hier ist ein Beispielauszug: UNTERKAPITEL B: FREIBRÄNDE §§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, Gültig ab 2017.
- Ein Leitdokument hingegen versucht, die wichtigsten Punkte der Verwaltungsvorschrift in verständlicher Sprache zu erklären, um dem normalen Bürger die Einhaltung der Vorschrift zu ermöglichen. Hier ist ein Beispielauszug: Freiluftverbrennung. Texas-Kommission für Umweltqualität, 2015.
Projektmöglichkeiten
Wenn Sie mutig genug sind, ein Leitdokument zu erstellen, versuchen Sie eine Verwaltungsvorschrift zu finden, die glücklicherweise kurz — unter 10 Seiten ist. Hier sind einige Möglichkeiten:
Erwägen Sie, über eines dieser Themen zu wählen und zu schreiben:
- Kapitel 361. Gesetz über die Entsorgung von festen Abfällen. Dieser hier behandelt die Vorschriften zu gebrauchten Reifen oder Asbest in Texas.
- AltreifenrecyclingTexas-Kommission für Umweltschutz
- Management von Gebrauchtreifen oder Schrottreifen
- Kapitel 2201, Boxen. Dies hier handelt nicht von Pappe!
- Kapitel 2100, Lizenzierung, Registrierung und Betrieb (von Friseurläden)
- Kapitel 5300, Ehe- und Familientherapie
Leitfadendokumentgestaltung
Einige Vorschläge für das Schreiben eines Leitdokuments:
- Denke daran, die tatsächliche Regel als Anhang einzufügen. Einige Regeldokumente können recht lang sein. Du kannst einfach die Abschnitte der Regeln kopieren, die in deiner Anleitung angesprochen werden.
- Fügen Sie so viele Anhänge wie praktisch — hinzu, insbesondere die, die "Standardtext" sind.
- Gestalten Sie Ihr Leitdokument mit einer Grafik, Überschriften und Unterüberschriften sowie anderen Merkmalen, die es wie ein echtes Leitdokument aussehen lassen.
KI-Anfragen für Richtliniendokumente
Checklisten, die normalerweise ungelesen bleiben, können nach einiger Modifikation als Quelle für KI-Eingaben verwendet werden. Kopiere das Folgende, füge es in ein KI-System wie Googles Gemini ein und sieh nach, was du vielleicht verpasst hast.
Hinweis: Alle Verweise auf den Inhalt, das Format, den Stil von Techdocs oder dessen Komponenten sind im Online-Lehrbuch für technische Dokumentation.
kommt bald!
Verwandte Informationen
Richtliniendokumente. U.S. Ministerium für Landwirtschaft
HHS Leitlinienportal. U.S. Ministerium für Gesundheit und soziale Dienste
Suchen Sie die TCEQ: Anleitung
Ich würde Ihre Gedanken, Reaktionen und Kritiken zu diesem Kapitel schätzen: Ihre Antwort—David McMurrey.
