Veuillez cliquer ici pour aider David McMurrey payer pour l'hébergement web :
Faites don de tout petit montant que vous pouvez !
La rédaction technique en ligne restera gratuite.
Voici deux définitions de documents d'orientation :
- 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 connexes et des liens vers des recherches connexes.
- Ailleurs, dans le monde gouvernemental, des documents de guide, ou guidance Les documents visent à fournir des informations utiles au public, telles que la clarification des obligations en vertu d'une loi ou d'un règlement existant, ou la fourniture d'informations sur les procédures de l'agence. En d'autres termes, ils traduisent le langage juridique complexe des règles administratives pour permettre au public de respecter ces règles.
Documents de guide
Un document de guide, à sa base, est un ensemble d'instructions mais avec d'autres ressources pour le rendre plus largement utile.
Révision 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 sous forme 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 premiers éléments de la liste suivante de titres ressemblent à un ensemble commun 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 de Jardin
Acquérir des outils de jardinage
Zones de jardinage de légumes aux États-Unis
Températures saisonnières moyennes aux États-Unis
Ravageurs Courants du Jardinage Légumes et Contrôle
Ressources de jardinage de légumes en ligne
Forums et communautés de jardinage de légumes
Adapté avec permission de Jardinage de légumes pour les 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 annoncent un document beaucoup plus long qu'un ensemble d'instructions d'une ou deux pages :
Sélection 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
Contrôle des nuisibles
Récolte
Choses à faire et à ne pas faire en jardinage
Adapté avec permission de Guide de jardinage de légumes à domicile au Texas Joseph Masabn, Texas A&M AgriLife.
Suppléments du Guide : Extras
Ce qui fait qu'un ensemble d'instructions est un guide ce sont les compléments discutés dans la section.
Théorie, Informations Conceptuelles
Les logiciels de création et de manipulation d'images ont une sérieuse responsabilité d'expliquer les courbes de couleur, les masques de calque, les canaux. Le merveilleux logiciel d'image gratuit GIMP a de bonnes explications sur les concepts à Courbes de couleur de base:
|
Couleurs de Pixel — par Pat David N'oubliez pas que 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 de 0 à 255, et en combinant ces trois couleurs avec des niveaux variés 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 du blanc pur. Si les trois canaux ont une valeur de 0 – alors la couleur résultante sera du noir pur. Si les trois canaux ont la même valeur, vous obtiendrez une nuance de gris (128,128,128 serait par exemple une couleur gris moyen). Voici quelques paramètres de couleur dans GIMP : 
Comme vous pouvez le voir, il y a plus de bleu que de tout autre couleur (c'est un pixel bleu après tout), suivi de vert, puis d'une touche de rouge. Si nous devions changer les valeurs de chaque canal, mais garder le même rapport entre le rouge, le vert et le bleu, alors nous garderions la même couleur et juste éclaircirions ou assombririons le pixel d'une certaine quantité. |
Informations de dépannage
Les informations de dépannage sont souvent formatées selon un principe d'essayer ceci, essayer 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 bien branché à l'arrière du boîtier de l'ordinateur et dans la prise électrique. ▢ 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 électrique. ▢ Solution 2 : S'il est branché à 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 secteur dans la prise murale, puis essayez de rallumer l'ordinateur. S'il ne se démarre toujours pas, vous devrez peut-être attendre quelques minutes et essayer à nouveau. |
Source : Adapté avec permission de Notions de base sur l'ordinateur - Techniques de dépannage de base
Communautés et Forums
Ressources connexes
Invites d'IA pour documents d'utilisation
Les listes de contrôle, qui restent généralement sans lecture, peuvent être utilisées comme source de prompts pour l'IA avec quelques modifications. Copiez ce qui suit, collez-le dans un système 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.
à venir bientôt !
Documents d'orientation
Comme présenté ici, les documents d'orientation traduisent les règles administratives en informations lisibles par des personnes ordinaires non juristes.
- Une règle administrative se caractérise par un langage fortement juridique et souvent technique. Voici un exemple d'extrait : 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 de orientation, en revanche, tente d'expliquer dans un langage accessible les points clés de la règle administrative pour permettre au citoyen ordinaire de se conformer à la règle. Voici un exemple d'extrait : Brûlage extérieur. Commission du Texas sur la qualité de l'environnement, 2015.
Possibilités de projet
Si vous êtes une âme suffisamment brave pour rédiger un document d'orientation, essayez de trouver une règle administrative qui est mercifullement brève—de moins de 10 pages. Voici quelques possibilités :
Considérez le choix et l'écriture sur l'un de ces éléments :
- Chapitre 361. Loi sur l'élimination des déchets solides. Celui-ci traite des règles concernant les pneus usagés ou l'amiante au Texas.
- Recyclage des huiles uséesCommission du Texas pour la qualité de l'environnement
- Gestion des pneus usagés ou hors d'usage
- Chapitre 2201, Boxe. Celui-ci n'est pas au sujet du carton !
- Chapitre 2100, Licences, Enregistrement et Fonctionnement (des salons de coiffure)
- Chapitre 5300, Thérapie conjugale et familiale
Conception de document d'orientation
Quelques suggestions pour rédiger un document de conseil :
- N'oubliez pas d'inclure 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 vos conseils.
- Incluez autant d'annexes que cela est pratique—en particulier celles qui sont « standard ».
- Habillez votre document d'orientation avec un graphique, des titres et sous-titres, et d'autres éléments qui lui donneront l'apparence d'un véritable document d'orientation.
Invitations IA pour documents de guidage
Les listes de contrôle, qui restent généralement non lues, peuvent être utilisées comme source de suggestions pour l'IA avec quelques modifications. Copiez ce qui suit, collez-le dans un système IA tel que Google Gemini, 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 !
Informations connexes
Documents d'orientation. Département de l'Agriculture des États-Unis
Portail d'Orientation du HHS. Département de la santé et des services sociaux des États-Unis
J'apprécierais vos pensées, réactions, critiques concernant ce chapitre : votre réponse—David McMurrey.
