About This Chapter
Below is a sample breakdown of the Technical Manual Writing Process chapter into a 5-day school week. Based on the pace of your course, you may need to adapt the lesson plan to fit your needs.
|Day||Topics||Key Terms and Concepts Covered|
|Monday||Structure, types and purpose of technical manuals||Examine the organizational structure, purpose and content of manuals; Types of technical manuals, including policy, procedure, operations, operator's, owner or user, service and maintenance, training, field and lab|
|Tuesday||Print manuals and e-manuals||Understanding print manuals and e-manuals and the benefits for each, depending on the audience|
|Wednesday||Manual writing issues||Issues that occur in manual writing, including updates and usability|
|Thursday||Standard operating procedure (SOP)||Purpose, content and organizational structure of standard operating procedures|
|Friday||Understanding the writing process for manuals||Prewriting, writing, rewriting, role of single sourcing, guidelines in writing manuals, manuals for transnational audiences, role of design in producing manuals|
1. The Purpose, Content & Structure of Manuals
Manuals are documentations of guidelines for understanding anything from policies to performing an activity. In this lesson, explore the purpose and content of manuals, as well as the common structure comprising front matter, body, and back matter.
2. Types & Purposes of Manuals
The purpose of a manual is to provide written instructions related to a workplace, organization, task, or item. Explore the common types of manuals, such as operations manuals and owner's manuals, and examine real-world examples.
3. Comparing Print Manuals & E-Manuals
Many products require a manual to provide customers with information about product features and usage. These manuals can be provided as printed documents or in electronic format. Compare print manuals to e-manuals, and recognize the advantages and disadvantages of each format.
4. Issues within Manual Writing
A manual is a document that accompanies products to inform customers about the products' usage. Review problems that can occur in manual writing, understand the concept of usability, and explore ways to address usability concerns, update manuals, and address updates.
5. Standard Operating Procedure (SOP): Purpose, Content & Structure
A standard operating procedure, or SOP, is a document detailing the expected actions within an organization. In this lesson, learn the purpose of an SOP and examine the typical structure which is followed when composing one.
6. The Writing Process for Manuals
Manuals are important technical documents that direct people on how to use a certain product. Explore the guidelines and writing process for manuals and learn important considerations like single-source publishing and international audiences.
Earning College Credit
Did you know… We have over 220 college courses that prepare you to earn credit by exam that is accepted by over 1,500 colleges and universities. You can test out of the first two years of college and save thousands off your degree. Anyone can earn credit-by-exam regardless of age or education level.
To learn more, visit our Earning Credit Page
Other chapters within the Technical Writing Syllabus Resource & Lesson Plans course
- Technical Writing Basics Lesson Plans
- Prewriting Lesson Plans
- Writing Technical Documents Lesson Plans
- Technical Editing & Rewriting Lesson Plans
- Parts of a Technical Document Lesson Plans
- Usability Testing & Technical Writing Lesson Plans
- Informal Technical Reports Lesson Plans
- Formal Technical Reports Lesson Plans
- Business Reports and Proposals Lesson Plans
- Technical Correspondence Lesson Plans
- Writing Resumes & Cover Letters Lesson Plans
- Technical Instructions Lesson Plans
- Proposal Writing Process Lesson Plans