HelpSmith

Last updated
HelpSmith
Developer(s) Divcom Software
Stable release
9.8 [1] / September 18, 2023;0 days ago (2023-09-18)
Operating system Microsoft Windows
Available inEnglish
Type IDE
License Trialware
Website www.helpsmith.com

HelpSmith is a Windows-based help authoring tool published by Divcom Software. [2]

Contents

HelpSmith allows a technical writer to create documentation in various formats, such as HTML Help (CHM), Web Help (HTML-based help system), PDF, and ePub. Also HelpSmith includes screen capture and image annotation tools.

History

Version 1.0 of HelpSmith was released in 2007 as a help authoring tool that had support for a single HTML Help (CHM) format. On February 7, 2008, HelpSmith was presented on the Giveaway of the Day website where the product received initial feedback and feature requests from its users. [3]

Over the past few years, HelpSmith has obtained support for the major documentation formats, support for High DPI displays, improvements to the user interface, and other enhancements. [4]

Key features

Similarly to common help authoring tools, HelpSmith includes a word processor to edit the content of help topics, customizable templates, user-defined variables, the ability to import existing documentation, media files management tools, support for various output formats, [5] conditional compilation capabilities, and other functions.

Image editing capabilities

The integrated Image Tool can be used by a technical writer to capture screenshots of an application or website, and to add annotations for elements demonstrated on a screenshot. The Image Tool also has support for control annotations which can be used for creation of user interface documentation. [6] [7]

Awards

Licensing terms

HelpSmith is available as a free trial version that can be downloaded for evaluation purposes from the official website. A single-user (per seat) license allows a customer to install HelpSmith Standard or HelpSmith Professional Edition on the main computer, and on a second computer, such as laptop. A multiple-user (floating) license allows a customer to install HelpSmith Terminal Server Edition on a terminal server in the client/server environment for concurrent usage by multiple users. [13]

See also

Related Research Articles

Microsoft Developer Network (MSDN) was the division of Microsoft responsible for managing the firm's relationship with developers and testers, such as hardware developers interested in the operating system (OS), and software developers developing on the various OS platforms or using the API or scripting languages of Microsoft's applications. The relationship management is situated in assorted media: web sites, newsletters, developer conferences, trade media, blogs and DVD distribution.

A technical writer is a professional information communicator whose task is to transfer information between two or more parties, through any medium that best facilitates the transfer and comprehension of the information. Technical writers research and create information through a variety of delivery media. Example types of information include online help, manuals, white papers, design specifications, project plans, and software test plans. With the rise of e-learning, technical writers are increasingly becoming involved with creating online training material.

LZX is an LZ77 family compression algorithm, a slightly improved version of DEFLATE. It is also the name of a file archiver with the same name. Both were invented by Jonathan Forbes and Tomi Poutanen in the 1990s.

Technical writing is the writing of technical content, particularly relating to industrial and other applied sciences, with an emphasis on occupational contexts. The range of audiences for technical writing varies widely. In some cases, it is directed to people with specialized knowledge, such as experts or technicians. In other situations, technical writers help convey complex scientific or niche subjects to end users who need a basic understanding of a concept rather than a full explanation of a subject. Technical writing is the largest part of technical communication.

A Help Authoring Tool or HAT is a software program used by technical writers to create online help systems.

Online help is topic-oriented, procedural or reference information delivered through computer software. It is a form of user assistance. The purpose of most online help is to assist in using a software application, web application or operating system. However, it can also present information on a broad range of subjects. Online help linked to the application's state is called Context-sensitive help.

Microsoft Compiled HTML Help is a Microsoft proprietary online help format, consisting of a collection of HTML pages, an index and other navigation tools. The files are compressed and deployed in a binary format with the extension .CHM, for Compiled HTML. The format is often used for software documentation.

Microsoft WinHelp is a proprietary format for online help files that can be displayed by the Microsoft Help browser winhelp.exe or winhlp32.exe. The file format is based on Rich Text Format (RTF). It remained a popular Help platform from Windows 3.0 through Windows XP. WinHelp was removed in Windows Vista purportedly to discourage software developers from using the obsolete format and encourage use of newer help formats.

The following is a comparison of e-book formats used to create and publish e-books.

<span class="mw-page-title-main">MadCap Software</span>

MadCap Software is an American computer software firm headquartered in San Diego, California that creates help authoring tools and solutions for technical writers and documentation teams. Several principal managers, software engineers, and support personnel were recruited from rival firms, such as Adobe Systems and Macromedia, to found MadCap Software. MadCap's authoring tools are all based on xHTML.

Microsoft Help 2.x is a proprietary format for online help files, developed by Microsoft and first released in 2001 as a help system for Visual Studio .NET (2002) and MSDN Library.

<span class="mw-page-title-main">VSdocman</span>

VSdocman is a documentation generator that allows for code commenting and the automatic generation of technical documentation from C# and VB .NET projects. It is directly integrated in Visual Studio as an extension.

<span class="mw-page-title-main">Okular</span> Document viewer by KDE

Okular is a multiplatform document viewer developed by the KDE community and based on Qt and KDE Frameworks libraries. It is distributed as part of the KDE Applications bundle. Its origins are from KPDF and it replaces KPDF, KGhostView, KFax, KFaxview and KDVI in KDE 4. Its functionality can be embedded in other applications.

<span class="mw-page-title-main">HelpNDoc</span>

HelpNDoc is a Windows-based help authoring tool published by French company IBE Software.

<span class="mw-page-title-main">STDU Viewer</span> Document viewer

STDU Viewer is computer software, a compact viewer for many computer file formats: Portable Document Format (PDF), World Wide Fund for Nature (WWF), DjVu, comic book archive, FB2, ePUB, XML Paper Specification (XPS), Text Compression for Reader (TCR), Mobipocket (MOBI), AZW, multi-page TIFF, text file (TXT), PalmDoc (PDB), Windows Metafile (EMF), Windows Metafile (WMF), bitmap (BMP), Graphics Interchange Format (GIF), JPEG-JPG, Portable Network Graphics (PNG), Photoshop Document (PSD), PiCture eXchange (PCX-DCX). It works under Microsoft Windows, and is free for non-commercial use.

XPS Annotator is a document management software program for Microsoft Windows that allows users to view, annotate, convert, sign and print XPS documents. The software was first released on 12 March 2009. It was created by Danang Probo Sayekti of Magelang, Indonesia.

List & Label is a professional reporting tool for software developers. It provides comprehensive design, print and export functions. The software component runs on Microsoft Windows and can be implemented in desktop, cloud and web applications. List & Label can be used to create user-defined dashboards, lists, invoices, forms and labels. It supports many development environments, frameworks and programming languages such as Microsoft Visual Studio, Embarcadero RAD Studio, .NET Framework, .NET Core, ASP.NET, C++, Delphi, Java, C Sharp and some more. List & Label either retrieves data from various sources via data binding, or works database independent. Reports are designed and created in the so-called List & Label Designer and then exported into a multitude of formats like PDF, Excel, XHTML and RTF. Since version 27 a web report designer for ASP.NET MVC is available.

<span class="mw-page-title-main">Daemon Tools</span> Software for virtual drives

DAEMON Tools is a virtual drive and optical disc authoring program for Microsoft Windows and Mac OS.

CloudApp is a cross-platform screen capture and screen recording desktop client that supports online storage and sharing.

References

  1. "HelpSmith Download Page". HelpSmith.
  2. "ComponentSource". ComponentSource. Retrieved 28 November 2019.
  3. "HelpSmith on GiveAwayOfTheDay". GiveAwayOfTheDay. Retrieved 27 November 2019.
  4. "HelpSmith - Change log". Softpedia. Retrieved 26 November 2019.
  5. Opris, Elena. "Softpedia". Softpedia. Retrieved 27 November 2019.
  6. Green, Ann. "Help Authoring Tool (HAT) Software Market New Technologies". Medium. Retrieved 18 February 2021.
  7. "Redesigned Image Tool with Various Annotations, Support for Hotspots, and Other Enhancements". HelpSmith. Retrieved 25 November 2019.
  8. "G2 Crowd - HelpSmith Reviews". G2 Crowd. Retrieved 17 April 2020.
  9. "G2 Crowd - Help authoring tools". G2 Crowd. Retrieved 25 November 2019.
  10. "Visual Studio Magazine Reader's Choice Award". GlobeNewsWire. Retrieved 27 November 2019.
  11. "Visual Studio Magazine's 2020 Reader's Choice Awards". Visual Studio Magazine. Converge360. Retrieved 5 May 2020.
  12. "Visual Studio Magazine 2021 Reader's Choice Award". GlobeNewsWire. Retrieved 18 February 2021.
  13. "HelpSmith EULA". HelpSmith Manual. Retrieved 18 October 2019.