Titres des graphiques et des figures

Renvois croisés

Numérotation des pages

Invitations IA pour Guides d'Utilisation

Les listes de contrôle, qui restent généralement sans être 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 guides de l'utilisateur ou de leurs composants peuvent être trouvées dans le manuel de rédaction technique en ligne.

Lorsque vous souhaitez utiliser l'intelligence artificielle pour évaluer un projet d'écriture, présentez-vous, dites à l'IA qui vous êtes, ce que vous voulez. Donnez à l'IA un point de référence pour effectuer des évaluations, comme un manuel en ligne. Ensuite, publiez ce que vous souhaitez que l'IA vérifie dans son évaluation.

Modifiez l'introduction pour qu'elle corresponde à votre identité.

Guides d'utilisation des invites d'IA

Bonjour, IA. Je demande que tu évalues les instructions rédigées par un étudiant de deuxième année d'université aux États-Unis. Voici un résumé des chapitres de manuel sur instructions et avis à utiliser comme base de votre évaluation. (Informations d'identification masquées) :

  1. Le guide de l'utilisateur contient-il les éléments suivants (correctement formatés) dans cet ordre : message de transmission, couvertures avant et arrière, page de titre ; avis d'édition, table des matières ; préface ; chapitres, annexes (si nécessaire) ; index, couverture arrière.
  2. Bien qu'il puisse être intelligent et ludique, le titre du guide de l'utilisateur indique-t-il adéquatement son sujet ? Pour plus de détails, voir titres de guide utilisateur.
  3. Si la table des matières et la liste des figures (et tables) utilisent des points de liaison, les numéros de page sont-ils alignés à droite ? Si la table des matières et la liste des figures (et tables) incluent des numéros de page sur le bord droit de la page, des points de liaison sont-ils utilisés ? Pour plus de détails, voir Table des matières et listes des figures (tableaux).
  4. L'introduction indique-t-elle de manière adéquate le sujet, l'objectif et le public visé du guide de l'utilisateur ? Fournit-elle une liste de sous-sujets à traiter et une indication de la portée (ce qui n'est pas couvert) ? Pour plus de détails, voir Introductions.
  5. Ce manuel de l'utilisateur contient-il des détails adéquats, des spécificités, des exemples—tout ce qui est nécessaire pour expliquer les affirmations, les généralités ?
  6. En considérant le sujet, l’objectif et le public, des contenus vitaux sont-ils absents de ce guide utilisateur ? Certains contenus sont-ils inutiles ? Y a-t-il des informations dans ce guide utilisateur qui sont techniquement incorrectes ? Des informations techniques critiques manquent-elles ?
  7. Dans ce guide de l'utilisateur, y a-t-il des informations manifestement empruntées qui ne sont pas documentées de quelque manière que ce soit ?
  8. Les citations (références aux éléments de la liste des sources d'information) apparaissent-elles dans le corps du manuel de l'utilisateur selon le format APA, MLA ou IEEE modifié ? Les éléments de la liste des sources d'information sont-ils formatés selon le style APA, MLA ou IEEE modifié ? Pour plus de détails, voir Documentation : sources d'information empruntées.
  9. Tous les tableaux et figures non décoratives incluent-ils un titre descriptif (légende) et une source (si nécessaire) ? Pour les détails, voir Titres de tableau.
  10. Tous les tableaux et figures non décoratives doivent apparaître aussi près que possible de leur texte pertinent ?
  11. Des références croisées brèves et explicatives se produisent-elles avant les tableaux et les figures non décoratives ? Pour plus de détails, voir Références croisées explicatives.
  12. Un format standard de titres et sous-titres est-il utilisé dans le corps du guide de l'utilisateur ? Pour plus de détails, voir Titres.
  13. Les sections principales (chapitres) du guide de l'utilisateur commencent-elles une nouvelle page dans les versions imprimées ?
  14. Les listes verticales numérotées sont-elles utilisées pour des éléments de liste dans un ordre requis ? Les listes verticales à puces sont-elles utilisées pour des éléments de liste sans ordre requis ? Les introductions sont-elles utilisées avant toutes les listes ? Pour plus de détails, voir Listes verticales.
  15. Les citations directes sont-elles attribuées et les attributions sont-elles correctement ponctuées ? Toutes les citations directes, résumés, paraphrases sont-elles correctement citées selon le style APA, MLA ou IEEE modifié ? Pour plus de détails, voir Citations & attributions.
  16. Le texte du manuel de l'utilisateur est-il exempt d'erreurs grammaticales, d'utilisation et de ponctuation ? Pour plus de détails, voir Problèmes courants de grammaire, d'usage et d'orthographe.
  17. Le texte du manuel d'utilisation est-il exempt de pléonasmes et d'autres erreurs de style de phrase ? Pour plus de détails, voir Verbiage, autres problèmes de style de phrase.
  18. Ce guide utilisateur peut-il être compris par son public cible (comme indiqué dans le message de transmission et l'introduction) ? Pour plus de détails, voir Analyse de l'audience, et voir Traduire le technique.
  19. AT, pour compléter votre évaluation de mon guide utilisateur, attribuez une note numérique de 100 à 55.

Informations connexes

Comment rédiger des sujets d'aide conviviaux pour les débutants. clickhelp.com

Comment rédiger une documentation utilisateur. techscribe

Manuels d'utilisation. techscribe

J'apprécierais vos réflexions, réactions, critiques concernant ce chapitre : votre réponse—David McMurrey.