This template pack includes multiple MS Word templates, checklists, forms, and an AI Prompt library with 100 prompts to help you research, write, edit, and publish all aspects of your next User Guide documentation project.
5 x User Guide Templates
Modify these templates to create user guides, user manuals, getting started guides and other types of technical documents.
AI Prompt Library for Technical Communicators
The toolkit is an elegantly simple MS Excel spreadsheet containing over 100 expert-crafted prompts, delivered as part of our Klariti User Guide template pack. See below for more details.
User Guide Templates: Table of Contents
1. Introduction
1.1. Purpose
1.2. Scope
1.3. System Organization
2. Describing the System
2.1. Key Features
2.2. Inventory
2.3. Environment
2.4. System Operations
3. Installing, Starting and Stopping the System
3.1. First-time Users
3.2. Access Control
3.3. Installing the system
3.4. Starting the system
3.5. Stopping and Suspending the system
4. Step by Step Instructions for using the system
4.1. Instructions
4.2. Conventions
4.3. Errors, Malfunctions, and Emergencies
4.4. Messages
4.5. Quick-Reference
5. How to use this template
5.1. How to add your logo to the cover page
5.2. How to add your logo to the header
5.3. Updating the Table of Contents
5.4. Adding Notes
5.5. Adding Warnings
5.6. Adding Comments
5.7. Bullet Lists
5.8. Numbered List
5.9. Adding Code Samples
5.10. Samples Tables
6. Appendix A – Reference Documents
7. Appendix B – Glossary of Terms
Product Specifications
All templates are in Microsoft Word format (.docx).
The template pack includes the following documents:
- 5 x User Guide Templates 22 pages each
- 1 x Information Asset Checklist
- 1 x User Guide Checklist
- 1 x User Guide Pre-Release Check
- 7 Forms
AI Prompt Toolkit for Technical Communicators
The toolkit is an elegantly simple MS Excel spreadsheet containing over 100 expert-crafted prompts, delivered as part of our Klariti User Guide template pack.
There are no macros to install and no software to learn. Just open the file, copy a prompt, and paste it into your LLM of choice—ChatGPT, Google Gemini, Claude, Perplexity, or any other.
Inside, you’ll find two powerful libraries:
-
- The Prompt Library for User Guides (57 Prompts)
This is your tactical, section-by-section guide. For every chapter in our industry-standard User Guide template, you get three levels of prompts:- Simple Prompts: For generating foundational, clear-cut content instantly.
- Advanced Prompts: For adding layers of detail, context, and user benefit.
- Complex Prompts: For tackling nuanced scenarios, analyzing impacts, and writing for expert-level users.
- The Prompt Library for User Guides (57 Prompts)
- The Prompt Library for Technical Communicators (43 Prompts)
Think of this as a playbook for documentation excellence. These prompts go beyond filling in sections and help you master the entire documentation lifecycle, with prompts for:- Information Architecture & Content Audits
- Writing for High-Stress Scenarios & Negative Paths
- Documenting APIs, CLIs, and Configuration Files
- Developing a Content Reuse Strategy & Maintenance Plan
- Justifying Your Work with Business Metrics
- …and dozens more expert-level tasks.