How to Build Professional CHM Manuals with WinCHM ProCreating a professional CHM (Compiled HTML Help) manual can dramatically improve how users interact with your software, hardware, or documentation. WinCHM Pro is a focused help-authoring tool that makes the process straightforward while offering enough control for polished, production-ready manuals. This guide walks you through planning, creating, editing, compiling, and distributing a CHM manual using WinCHM Pro.
Why choose CHM and WinCHM Pro?
- CHM is a widely supported, single-file help format for Windows applications that bundles HTML pages, images, and navigation into one compact file.
- WinCHM Pro offers a simple WYSIWYG editor plus HTML source control, topic management, table of contents (TOC) and index building, full-text search, and project compilation into CHM.
- It’s fast and lightweight, suitable for technical writers, developers, and support teams who need predictable output without a steep learning curve.
1. Planning your manual
Successful help systems start with planning. Before opening WinCHM Pro:
- Define the audience and use cases (end users, administrators, developers).
- Create an outline of topics grouped into logical sections (getting started, tutorials, reference, troubleshooting).
- Determine required assets: screenshots, diagrams, sample files, code snippets, and legal notices.
- Decide localization needs and whether you’ll build language variants.
- Set a naming convention for topics and images to keep the project organized.
2. Setting up a new project in WinCHM Pro
- Launch WinCHM Pro and choose “New Project.”
- Select the CHM project template and provide a project name and output filename (e.g., MyAppHelp.chm).
- Configure basic settings:
- Title shown in the CHM window.
- Default charset and language.
- Window type and toolbar options for the compiled help.
- Save the project file (.whp) in a dedicated folder alongside media assets.
3. Organizing the Table of Contents (TOC) and Index
A clear TOC and index are essential:
- Use the TOC tree to mirror your planned outline. Create parent and child nodes for modules and subtopics.
- Keep topic granularity useful: one focused subject per topic helps search and reuse.
- Build an index with key terms and associate them to topics. Be concise with index entries—users scan the index quickly.
- Use topic aliases when a single topic should appear under multiple index terms or TOC locations.
4. Writing and formatting topics
WinCHM Pro supports both WYSIWYG and HTML source editing:
- Use the WYSIWYG editor for rapid authoring; switch to HTML for precise formatting or embedding custom scripts/styles.
- Keep content scannable: short paragraphs, descriptive headings, numbered steps, and bullet lists.
- Use consistent voice and terminology—establish style rules for UI labels, code font, and capitalization.
- Insert screenshots and annotate them. Use lossless PNG for UI details and JPG for photos. Crop tightly and add callouts for clarity.
- For code samples, use a monospaced font and preserve indentation. Consider highlighting important lines.
Example structure for a typical topic:
- Title (H1/H2)
- Short summary sentence
- Step-by-step instructions or conceptual content
- Screenshot or example
- Related links or “See also”
5. Adding multimedia and attachments
- Embed images via the editor’s image tool; WinCHM copies images into the project folder for portability.
- Attach downloadable files (ZIPs, sample data, config files) using the Attachments feature so users can open/download them directly from the CHM.
- Avoid heavy video files inside CHM—link to external hosted videos or include small clips if necessary.
6. Cross-references and navigation aids
- Create hyperlinks between related topics for context and flow.
- Use “Next” and “Previous” navigation where step sequences exist.
- Implement breadcrumbs inside topics (small path line) to help users understand their location.
- Add a “Search” tip section if your manual is large, explaining how to form effective queries.
7. Localizing and versioning the manual
- For localization, keep all source topics in one project and export content for translators, or create parallel projects per language.
- Version the manual with a visible version number in the title and a revision history topic.
- Maintain a changelog topic linked from the front page so users see what changed between releases.
8. Building the full-text search and compiling
- Configure search settings in WinCHM Pro to ensure full-text indexing is enabled and that common stopwords are considered.
- Before compiling, run a link checker to find broken hyperlinks.
- Use the Preview feature to inspect topics in a compiled-like viewer.
- Compile the project to CHM. If you get errors, inspect the log and resolve missing resources or invalid HTML.
9. Testing your CHM
- Open the compiled CHM on target Windows versions (match the OS versions your users use).
- Test TOC, index entries, full-text search, attachments, external links, and navigation controls.
- Verify images render at expected quality and check that character encoding displays correctly for non-English text.
- Get feedback from a small group of users to catch usability problems.
10. Distribution and integration
- Distribute CHM as a downloadable from your website or bundle it with your installer.
- If integrating into an application, set the help button to open the CHM file at a specific topic using the help API or invoking HTMLHelp.exe with a topic URL.
- Digitally sign installers if you distribute via executable packages to avoid Windows blocking downloads.
11. Maintenance and updates
- Keep the source project under version control (Git or similar) so content updates and history are tracked.
- Schedule periodic reviews of accuracy, screenshots, and links.
- When software changes, update related topics and increment the manual version. Re-compile and re-test before release.
Tips and best practices
- Reuse topics: avoid copying the same content in multiple places; link instead.
- Use templates for recurring topic types (how-to, reference, troubleshooting).
- Optimize images: balance clarity with file size to keep CHM compact.
- Keep help content actionable—users primarily want solutions to tasks and problems.
- Train contributors on your style and the WinCHM Pro workflow to keep output consistent.
Example minimal workflow (quick checklist)
- Plan outline and assets.
- Create new WinCHM Pro project.
- Add TOC and write topics.
- Insert images/attachments and cross-links.
- Build index and configure search.
- Compile CHM and test on target systems.
- Distribute and collect feedback.
By following these steps and using WinCHM Pro’s authoring and compilation features, you can efficiently produce compact, navigable, and professional CHM manuals that help users find answers and complete tasks with confidence.
Leave a Reply