www.help-author.com Open in urlscan Pro
185.142.32.144  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Help Author
Help AuthoringCreate a Help FileHelp FormatsHelp ToolsQuality
ChecklistCommunitiesDownload HelpSmith
Help authoring
Help AuthoringHelp FormatsQuality ChecklistDownload HelpSmith
Creation of Help Files
Create a Help FileHow to Create HTML Help .CHM Help FilesHow to Create an Online
Web Help SystemKnown CHM File Issues and Solutions
Help File Integration
How to Use HTML Help .CHM Files in a .NET ApplicationHow to Link an HTML Help
.CHM File with a Delphi ApplicationHow to Integrate a CHM File with MS Office
VBA Application


INTRODUCTION TO HELP AUTHORING

In computer science, help authoring stands for writing technical documentation
such as an application help file, online manual for a web service, or a printed
manual for a device. However, for a technical writer who works on documentation,
help authoring involves many different processes such as:

 * Analysis of the subject being documented;
 * Writing help file content;
 * Creation of illustrations such as images, screenshots, schemes, diagrams,
   etc.;
 * Creation of videos (for example, screencasts);
 * Help file quality control (including editing and proofreading of written
   text, working on the document structure, working on the common style and
   appearance, etc.);
 * Integration of the help file with an application, website and providing
   context-sensitive help, etc. (see our instructions for .NET, Delphi, and
   VBA);
 * Localization of a help file (e.g., translation of an existing help file to
   another language).

Thus, it is obvious that a technical writer should have certain writing and
instrumental skills including the ability to work with specialized software
tools such as help authoring tools, image editing tools, screen capture, and
screen recording software.


HELP AUTHORING RESOURCES

Below you will find general information on help authoring, step-by-step
instructions on creating a help file or manual, specific pages on HTML Help
(CHM) and Web Help systems, and also information on documentation tools that you
can use for your own project.

General Information
Introduction to Help AuthoringHelp File and Documentation FormatsHelp File
Quality ChecklistDownload HelpSmith
Help File Creation
How to Create a Help File, Web Help System, or Printed ManualHow to Create a CHM
Help FileHow to Create a Web Help SystemKnown CHM File Issues and Solutions
Help Authoring Tools
Help Authoring ToolsHow to Select a Help Authoring Tool for Your ProjectScreen
Capture and Screen Recording Tools


HOW TO CREATE A QUALITY HELP FILE



If you are a beginner technical writer, you can visit our step-by-step
instructions explaining how you can create your first help file using a help
authoring tool.

 * How to Create a Help File

In addition, we have prepared a checklist that you can use to control the
quality of your help files and manuals by providing well-structured and clear
documentation, so your users will be able to find a solution to a specific task
or issue easily.

 * Help File Quality Checklist


HELP AUTHORING PROFESSIONALS

If you need to integrate a help system with your application, you can find the
articles for developers below. Also, you can see our list of online communities
where you can discuss questions with other professionals.

Help File Integration
How to Use HTML Help .CHM Files in a .NET ApplicationHow to Link an HTML Help
.CHM File with a Delphi ApplicationHow to Integrate a CHM File with MS Office
VBA Application
Technical Writing Communities
Help Authoring Communities


DOCUMENTATION AND RELATED TOOLS



If you a looking for a help file tool or related tools such as screen capture
and screencasting applications, you can find a quick overview of some popular
products.

 * Help authoring tools
 * Screen capture and screencasting tools

To help you select a help authoring tool for your documentation project, we have
also prepared a list of features that you may need to complete your project.

 * Features of a help file tool


DOWNLOAD A HELP AUTHORING TOOL

You can download one of the recommendable help authoring tools that combines a
rich feature-set, slight learning curve, and affordable price.

HelpSmith main window

Product Details:

Detail Value Product HelpSmith 10.0 Filename HelpSmithSetup.exe File size 65 MB
Platform Windows 11/10/8/7 System requirements 1 GHz processor, 512MB RAM, 150MB
free disk space

Download HelpSmith
© 2014-2024 Technical Communication Group. All Right Reserved.