Veuillez cliquer ici pour aider. David McMurrey payer pour l'hébergement web :
Faites un don, même d'un petit montant, si vous le pouvez !
La rédaction technique en ligne restera gratuite.
Voici deux définitions de documents de guide :
- Un guide est un document, une publication ou une ressource numérique qui fournit des instructions étape par étape, des conseils et des informations sur la façon d'effectuer des tâches spécifiques, d'utiliser des produits ou de comprendre des concepts complexes. Un guide peut également contenir des informations de dépannage, des liens vers des communautés associées et des liens vers des recherches connexes.
- Ailleurs, dans le monde gouvernemental, des documents directeurs, ou orientation Les documents sont destinés à fournir des informations utiles au public, comme clarifier les obligations en vertu d'une loi ou d'un règlement existant, ou fournir des informations sur les procédures de l'agence. Autrement dit, ils traduisent le langage juridique complexe des règles administratives pour permettre au public de se conformer à ces règles.
Documents de Guide
Un document guide, en son cœur, est un ensemble d'instructions mais avec d'autres ressources pour le rendre plus largement utile.
Revue du chapitre sur instructions, vous voyez que les instructions sont xxées par une section détaillant l'équipement et les fournitures nécessaires et par une section détaillant les étapes procédurales souvent dans un format de liste verticale numérotée. Incluez une section comme celle-ci dans votre document de guide—mais ce n'est pas tout !
Guide des fondations : Instructions
Les six premières instructions de la liste suivante ressemblent à un ensemble courant d'instructions—mais pas le reste !
Choisissez le bon emplacement
Choisissez la taille du jardin
Choisissez des légumes
Déterminez Où et Quand Planter
Déterminez Quand Planter Quoi
Concevez le Plan du Jardin
Acquérir des outils de jardinage
Zones de jardinage végétal aux États-Unis
Températures saisonnières moyennes aux États-Unis
Ravageurs courants du jardinage de légumes et contrôle
Ressources en ligne pour le jardinage des légumes
Forums et Communautés de Jardinage de Légumes
Adapté avec la permission de Jardinage de légumes pour débutants : Le guide complet
Même la longueur et le détail des six premiers éléments sont supérieurs à ce que vous pourriez attendre dans un ensemble d'instructions commun de deux pages, sans parler des jolies images décoratives.
Voici une autre liste de titres qui présagent un document beaucoup plus long qu'un ensemble d'instructions d'une ou deux pages :
Choix du site de jardin
Sélection de Culture
Plan de jardin : Emplacement, Rotation
Préparation du sol
Fécondation
Plantation
Arrosage
Contrôle des mauvaises herbes
Paillage
Lutte contre les nuisibles
Récolte
À faire et à ne pas faire en jardinage
Adapté avec la permission de Guide de jardinage de légumes à la maison au Texas Joseph Masabn, Texas A&M AgriLife.
Guide Suppléments : Extras
Ce qui fait qu'un ensemble d'instructions est un guide, ce sont les compléments discutés dans la section.
Théorie, Information Conceptuelle
Les logiciels de création et de manipulation d'images ont une responsabilité sérieuse d'expliquer les courbes de couleur, les masques de calque, les canaux. Le merveilleux logiciel d'image gratuit GIMP a de bonnes explications sur ces concepts à courbes de couleur de base:
|
Couleurs des pixels — par Pat David N'oubliez pas, chaque pixel est représenté par une combinaison de 3 couleurs : Rouge, Vert et Bleu. Dans GIMP (actuellement en 8 bits), cela signifie que chaque couleur RVB peut avoir une valeur comprise entre 0 et 255, et en combinant ces trois couleurs avec des niveaux variables dans chaque canal, vous obtiendrez toutes les couleurs que vous pouvez voir dans votre image. Si les trois canaux ont une valeur de 255, alors la couleur résultante sera un blanc pur. Si les trois canaux ont une valeur de 0 – alors la couleur résultante sera un noir pur. Si les trois canaux ont la même valeur, alors vous obtiendrez une nuance de gris (128,128,128 serait par exemple une couleur grise intermédiaire). Voici quelques réglages de couleur dans GIMP : 
Comme vous pouvez le voir, il y a plus de bleu que quoi que ce soit d'autre (c'est un pixel bleuâtre après tout), suivi de vert, puis d'une touche de rouge. Si nous devions changer les valeurs de chaque canal, mais gardions le même ratio entre le rouge, le vert et le bleu, nous garderions la même couleur et éclaircisserions ou assombririons simplement le pixel d'un certain montant. |
Informations de dépannage
Les informations de dépannage sont souvent présentées sous la forme d'un cadre essaie ceci, essaie cela.
|
Problème : Le bouton d'alimentation ne démarre pas l'ordinateur. ▢ Solution 1 : Si votre ordinateur ne démarre pas, commencez par vérifier le cordon d'alimentation pour confirmer qu'il est correctement branché à l'arrière du boîtier de l'ordinateur et à la prise de courant. ▢ Solution 1 : Si votre ordinateur ne démarre pas, commencez par vérifier le cordon d'alimentation pour confirmer qu'il est bien branché à l'arrière du boîtier de l'ordinateur et à la prise électrique. ▢ Solution 2 : S'il est branché sur une prise, assurez-vous qu'elle fonctionne. Pour vérifier votre prise, vous pouvez y brancher un autre appareil électrique, comme une lampe. ▢ Solution 3 : Si l'ordinateur est branché sur un parasurtenseur, vérifiez qu'il est allumé. Vous devrez peut-être réinitialiser le parasurtenseur en l'éteignant puis en le rallumant. Vous pouvez également brancher une lampe ou un autre appareil sur le parasurtenseur pour vérifier qu'il fonctionne correctement. ▢ Solution 4 : Si vous utilisez un ordinateur portable, la batterie peut ne pas être chargée. Branchez l'adaptateur CA dans le mur, puis essayez d'allumer l'ordinateur portable. S'il ne démarre toujours pas, vous devrez peut-être attendre quelques minutes et réessayer. |
Source : Adapté avec permission de Bases de l'informatique - Techniques de dépannage de base
Communautés et forums
Ressources Connexes
Invitations IA pour documents de guide
Les listes de contrôle, qui restent généralement non lues, peuvent être utilisées comme source de prompts pour l'IA avec quelques modifications. Copiez ce qui suit, collez-le dans un système d'IA tel que Gemini de Google, et voyez ce que vous avez peut-être manqué.
Remarque : Toutes les références au contenu, au format, au style des techdocs ou de ses composants peuvent être trouvées dans le manuel de rédaction technique en ligne.
bientôt disponible !
Documents d'orientation
Comme présenté ici, les documents d'orientation traduisent les règles administratives en informations compréhensibles par des personnes ordinaires non juristes.
- Une règle administrative se caractérise par un langage fortement juridique et souvent par un langage technique. Voici un extrait d'exemple : SOUS-CHAPITRE B : BRÛLAGE EN PLEIN AIR §§111.201, 111.203, 111.205, 111.207, 111.209, 111.211, 111.213, 111.215, 111.217, 111.219, 111.221. Commission du Texas pour la qualité de l'environnement, En vigueur depuis 2017.
- Un document d'orientation, d'autre part, tente d'expliquer dans un langage accessible les points clés de la règle administrative afin de permettre au citoyen ordinaire de se conformer à la règle. Voici un extrait d'exemple : Brûlage extérieur. Commission du Texas sur la qualité de l'environnement, 2015.
Possibilités de projet
Si vous êtes une âme suffisamment courageuse pour rédiger un document d'orientation, essayez de trouver une règle administrative qui est heureusement brève—de moins de 10 pages. Voici quelques possibilités :
Envisagez de sélectionner et d'écrire sur l'un de ces sujets :
- Chapitre 361. Loi sur l'élimination des déchets solides. Celui-ci traite des règles sur les pneus usagés ou l'amiante au Texas.
- Recyclage de l'huile usagéeCommission du Texas sur la qualité de l'environnement
- Gestion des pneus usagés ou hors d'usage
- Chapitre 2201, Boxe. Celui-ci ne concerne pas le carton !
- Chapitre 2100, Licences, Enregistrement et Fonctionnement (des salons de coiffure)
- Chapitre 5300, Thérapie de couple et de famille
Conception de document de guidance
Quelques suggestions pour rédiger un document de guidance :
- N'oubliez pas de copier la règle réelle en annexe. Certains documents de règles peuvent être assez longs. Vous pouvez simplement copier les sections des règles abordées dans votre guide.
- Incluez autant d'annexes que cela est pratique—en particulier celles qui sont "types."
- Habillez votre document de guidance avec un graphique, des titres et des sous-titres, et d'autres éléments qui le feront ressembler à un véritable document de guidance.
Invites IA pour documents d'orientation
Les listes de contrôle, qui restent généralement non lues, peuvent être utilisées comme source pour des invites d'IA avec quelques modifications. Copiez ce qui suit, collez-le dans un système d'IA tel que Gemini de Google, et voyez ce que vous avez peut-être manqué.
Remarque : Toutes les références au contenu, au format, au style des techdocs ou à ses composants peuvent être trouvées dans le manuel de rédaction technique en ligne.
bientôt disponible !
Informations connexes
Documents d'orientation. Département de l'Agriculture des États-Unis
Portail de directives du HHS. Département de la santé et des services humains des États-Unis
Rechercher le TCEQ : Directives
J'apprécierais vos réflexions, réactions, critiques concernant ce chapitre : votre réponse—David McMurrey.
