Step-by-Step Guide: Writing Manuals with Dr.Explain Creating clear user documentation is essential for any software product. Dr.Explain simplifies this process by capturing application screens and automatically creating callouts for user interface elements. This guide provides a structured workflow to build a professional user manual from scratch. Phase 1: Set Up Your Project
Begin by configuring your working environment to match your output goals. Launch Dr.Explain: Click New Project on the start screen.
Set Properties: Enter your product name, version, and author details.
Choose Formats: Select your primary outputs like CHM, PDF, or HTML.
Configure Style: Pick a visual theme that matches your corporate branding. Phase 2: Capture Application Screens
The core strength of Dr.Explain is its ability to analyze and document user interfaces automatically.
Prepare Target: Open your software application to the desired screen.
Initiate Capture: Click the Capture a Window button in Dr.Explain.
Select Window: Hover over your software and click to capture it.
Review Elements: Let the built-in designer automatically find buttons and fields.
Approve Structure: Click OK to import the annotated image into your project. Phase 3: Enrich Content and Describe Controls
Once the software interface is captured, add the instructional text.
Name Topics: Give the newly created page a clear, action-oriented title.
Add Context: Write a brief introductory paragraph explaining the screen’s purpose.
Edit Callouts: Click on the numbered bullets to customize the pointer lines.
Fill Descriptions: Type exact instructional steps next to each automated control label.
Insert Notes: Use information boxes to highlight critical warnings or tips. Phase 4: Organize the Manual Structure
A logical flow helps users find answers quickly without getting frustrated.
Create Hierarchy: Drag and drop topics to arrange them logically.
Add Sections: Insert empty topics for high-level conceptual overviews.
Build Index: Assign keywords to pages to enable index-based searching.
Link Topics: Insert hyperlinks between related procedures within the text. Phase 5: Export and Publish
The final step is compiling your project into distribution-ready formats.
Run Validation: Check all internal hyperlinks and spellings. Click Export: Choose your format from the main toolbar.
Adjust Layouts: Fine-tune PDF page breaks or HTML navigation menus if prompted.
Generate File: Click Start Export to create your final documentation.
To tailor this article precisely to your needs, please share a few more details:
Are there any specific features of Dr.Explain you want to emphasize? (e.g., web-help hosting, localized outputs) Saved time Comprehensive Inappropriate Not working
A copy of this chat, including the images and video, will be included with your feedback A copy of this chat will be included with your feedback
Your feedback will include a copy of this chat and the image from your search
Your feedback will include a copy of this chat, any links you shared, and the image from your search.
Thanks for letting us know
Google may use account and system data to understand your feedback and improve our services, subject to our Privacy Policy and Terms of Service. For legal issues, make a legal removal request.