Please click here to help David McMurrey pay for web hosting:
Donate any small amount you can
Online Technical Writing will remain free.
This page is under repair.
NotebookLLM-generated infographic of this chapter
Transmittal Message
Front and back covers
Title page
Edition Notice, Copyrights, Trademarks
Table of Contents
Preface
User Guide Main Chapters
Appendixes
Appendixes
Index
Other User Guide Elements
Headings
Bulleted and Numbered Lists
Symbols, Numbers, and Abbreviations
Graphics and Figure Titles
Cross-References
Page Numbering
AI Prompts for User Guides
Checklists, which typically go unread, can be used as source for AI prompts with some modification. Copy the following, paste it into an AI system such as Google's Gemini, and see what you may have missed.
Note: All references to the content, format, style of user guides or their components can be found in the online technical-writing textbook.
When you want to use AI to evaluate a writing project, introduce yourself, tell AI who you are, what you want. Give AI a reference point for doing evaluations like an online textbook. Then post what you want AI to check in its evaluation.
Modify the introduction to fit your identity.
|
AI Prompts User Guides
Hello, AI. I am requesting that you evaluate instructions written by a U.S. college sophomore. Below is a summary of textbook chapters on instructions and notices to use as the basis of your evaluation. (Identifying information masked):
Does the user guide contain the following (properly formatted) in this order: transmittal message, front and back covers, title page; edition notice, table of contents; preface; chapters, appendixes (as needed); index, back cover.
While it can be clever and playful, does the title of the user guide adequately indicate its subject matter? For details, see user guide titles.
If the table of contents and list of figures (and table) use leader dots, are the page numbers right-aligned. If the table of contents and list of figures (and table) include page numbers on the right edge of the page, are leader dots used? For details, see TOCs and List of Figures (Tables).
Does the introduction adequately indicate the topic, purpose, and intended audience of the user guide? Does it provide a list of subtopics to be covered and an indication of
scope (what's not covered)? For details, see Introductions.
Does this user guide contain adequate details, specifics, examples—whatever is needed to explain the assertions, the generalities?
Considering the topic, purpose, and audience, are any vital contents missing from this user guide? Are any contents unnecessary? Is any information is this user guide technically incorrect? Is any critical technical information missing?
In this user guide, does contain any obviously borrowed information that is not documented in any way?
Do the citations (references to items in the information-sources list) occur in the body of the user guideformatted according to APA, MLA, or modified IEEE style? Are the items in the information sources list formatted according to APA, MLA, or modified IEEE style? For details, see Documentation: borrowed information sources.
Do all tables and non-decorative figures include a descriptive title (caption) and source (if needed)? For details, see Table titles.
Do all tables and non-decorative figures occur as near as posible to their relevant text?
Do briefly explanatory cross-reference occur before the tables and non-decorative figures? For details, see Explanatory cross-references.
Is a standard format of headings and subheadings used in the body of the user guide? For details, see Headings.
Do main sections (chapters) of the user guide start a new page in print versions?
Are numbered vertical lists used for list items in a required order? Are bulleted vertical lists used for list items in no required order? Are lead-ins use before all lists? For details, see Vertical lists.
Are direct quotations attributed, and are the attributions correctly punctuated? Are all direct quotations, summaries, paraphrases properly cited according to APA, MLA, or modified IEEE style? For details, see Quotations & attributions.
Is the text of the user guide free of grammar, usage, and punctuation errors? For details, see Common Grammar, Usage, Spelling Problems.
Is the text of the user guide free of wordiness and other sentence style errors? For details, see Wordiness, other sentence-style problems.
Can this user guide be understood by its target audience (as indicated in the transmittal message and introduction)? For details, see Audience analysis, and see Translating the Technical.
AT, to complete your evaluation of my user guide, assign a numeric grade from 100 to 55).
|
Related Information
How to Write User Friendly Help Topics for Beginners. clickhelp.com
How to write user documentation. techscribe
User guides. techscribe
I would appreciate your thoughts, reactions, criticism regarding this chapter:
your response—David McMurrey.
