Veuillez cliquer ici pour aider. David McMurrey payer pour l'hébergement web :
Faites un don de tout petit montant que vous pouvez !
La rédaction technique en ligne restera gratuite.
Voici deux définitions de documents de guide :
- A guide est un document, une publication ou une ressource numérique qui fournit des instructions pas à pas, des conseils et des informations sur comment réaliser des tâches spécifiques, utiliser des produits ou 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 guides, ou orientation Les documents sont destinés à 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 légal 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.
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 Fondations : Instructions
Les six premiers éléments de la liste suivante de titres ressemblent à un ensemble d'instructions courant—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
Achetez 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 de légumes et contrôle
Ressources en ligne pour le jardinage des légumes
Forums et Communautés de Jardinage Légumes
Adapté avec 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émissent un document beaucoup plus long qu'un ensemble d'instructions d'une ou deux pages :
Sélection de l'emplacement du jardin
Sélection de culture
Plan de jardin : Emplacement, Rotation
Préparation du sol
Fertilisation
Plantation
Arrosage
Contrôle des mauvaises herbes
Paillage
Contrôle des nuisibles
Récolte
À faire et à ne pas faire en jardinage
Adapté avec la permission de Guide de jardinage des 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 supplé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 des concepts à Courbes de couleur de base:
|
Couleurs de pixel — 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 RGB peut avoir une valeur de 0 à 255, et combiner ces trois couleurs avec des niveaux variables dans chaque canal donnera 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, vous obtiendrez une nuance de gris (128,128,128 serait une couleur gris moyen par exemple). Voici quelques paramètres de couleur dans GIMP : 
Comme vous pouvez le voir, il y a plus de bleu que de toute autre couleur (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, tout en maintenant le même rapport entre le rouge, le vert et le bleu, nous conserverions la même couleur et nous éclaircirions ou assombririons simplement le pixel d'un certain montant. |
Informations de dépannage
Les informations de dépannage sont souvent présentées sous 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 bien branché à l'arrière du boîtier de l'ordinateur et à 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é au dos du boîtier de l'ordinateur et à la prise électrique. ▢ Solution 2 : S'il est branché à une prise, assurez-vous qu'il s'agit d'une prise fonctionnelle. Pour vérifier votre prise, vous pouvez 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 le mur, puis essayez de mettre l'ordinateur portable sous tension. S'il ne démarre toujours pas, vous devrez peut-être attendre quelques minutes et réessayer. |
Source : Adapté avec la permission de Bases de l'informatique - Techniques de dépannage de base
Communautés et Forums
Ressources associées
Invites d'IA pour documents de guide
Les listes de contrôle, qui demeurent 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 IA tel que Gemini de Google, et voyez ce que vous avez pu manquer.
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.
arrivée prochaine !
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 est marquée par un langage fortement légaliste et souvent par un langage technique. Voici un extrait d'exemple : SOUS-CHAPITRE B : INCENDIE 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 sur la qualité environnementale, En vigueur depuis 2017.
- Un document d'orientation, en revanche, 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 à cette règle. Voici un extrait d'exemple : Brûlage à l'extérieur. Commission du Texas sur la qualité de l'environnement, 2015.
Possibilités de projet
Si vous êtes une personne assez courageuse 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 :
Envisagez de choisir 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 concernant 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 n'est pas une question de carton !
- Chapitre 2100, Licence, Enregistrement et Opération (des salons de coiffure)
- Chapitre 5300, Thérapie par le mariage et la famille
Document de guide de conception
Quelques suggestions pour rédiger un document d'orientation :
- 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 mentionnées dans votre guide.
- Inclure autant d'annexes que cela est pratique — en particulier celles qui sont "standards."
- Habillez votre document de guidage d'un graphique, de titres et de sous-titres, et d'autres caractéristiques qui le feront ressembler à un véritable document de guidage.
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 Google Gemini, et voyez ce que vous avez pu manquer.
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 !
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 sociaux des États-Unis
J'apprécierais vos pensées, réactions, critiques concernant ce chapitre : votre réponse—David McMurrey.
