Resources
Articles
| Considerations for Bigger Projects | This article outlines strategies and techniques for setup and management of bigger source code documentation projects. |
| Plugging into Help 2 Systems | This article explains the plug-in integration process of Doc-O-Matic generated Help 2 systems such as the Microsoft Visual Studio Documentation and the Borland Help System. |
| Using TFHxReg for Help 2 Registration | Beginning with version 6, Doc-O-Matic comes with its own tool for registering Help 2 content, named TFHxReg. It is a command line utility that takes an XML command file as input. The command file contains the instructions for registration and unregistration of namespaces, titles, filters and plugins. |
| Using Modules | Modules allow for dividing the output into separate parts with their own symbol reference structure and class hierarchy diagram. This article provides a quick introduction into setting up modules for your project. |
| Branding the Output | This article describes the basic steps to brand the output to make it fit into your corporate identity. |
| Localization | This article provides step-by-step instructions on how to achieve fully localized documentation output in your language. |
| Master and Dependent Projects | A new feature in Doc-O-Matic 6 Professional is the ability to inherit all settings from another project by defining a master project. When a master project is used, a project only saves settings that that are different to the master project's setup. This article explains how to setup a master-dependent project hierarchy successfully. |
| Team Development | Doc-O-Matic works great in a team development environment. This article explains strategies on how to setup and use Doc-O-Matic in an mixed development environment with programmers editing source, technical writers working on off-source documentation and documentation managers responsible for project management. |
Help Compilers
In order for Doc-O-Matic to build online Help systems you need Help compilers. For Help 2 these are available as part of the SDKs of Visual Studio for Help 2. Help compilers for HTML Help and Windows Help are available as well.
| Visual Studio 2010 SDK | There's no need for a Help compiler for integrating with Visual Studio 2010, but there's still an SDK you can take a look at. |
| Visual Studio 2008 SDK Download | The Help Compiler for Help 2 is part of the Visual Studio 2008 SDK. Help for the SDK is available here. |
| Visual Studio 2005 SDK Download | The Help Compiler for Help 2 is part of the Visual Studio 2005 SDK. |
| Visual Studio 2003 SDK Download | The Help Compiler for Help 2 is part of the Microsoft Visual Studio 2003 .NET Help Integration Kit. |
| HTML Help Compiler | The HTML Help Compiler for HTML Help 1.x can be downloaded as part of the Microsoft HTML Help Workshop from msdn.microsoft.com. |
| Windows Help Compiler Download | The Windows Help Compiler is more than 15 years old legacy technology. Not recommended for new projects, for stand-alone help use HTML Help. |
External Resources
The following are selected links to other web sites with useful information about source code documentation and Help authoring.
| WinWriters | WritersUA - Training and Information for User Assistance Professionals. |
| Helpware | Helpware is an excellent resource for questions around HTML Help, Help 2, Help 3 and Windows Help as well as Help authoring in general. They have lots of in-depth knowledge about Help compilers as well as up-to-date information on newest developments in the industry. |
| XML Documentation | Since Visual Studio 2003 you can document the code you write using XML Doc (which of course is supported by Doc-O-Matic). |
| How to Write Doc Comments for the Javadoc Tool | Comprehensive information about Sun's JavaDoc standard (supported by Doc-O-Matic). |
| MSDN Article on XML Comments | This article shows how to use XML comments and explains the relevant tags. The author demonstrates how to set up your project to export your XML comments into convenient documentation for the benefit of other developers. |
Prerequisites
Doc-O-Matic is a stand alone application, it requires no other applications to be pre-installed.
If you wish to create HTML Help, Help 2 or WinHelp online Help systems, you will need to install Help Compilers.
System Requirements
- Disk Space Required: 60MB
- Memory: 256MB Minimum, 1GB Recommended
- Operating System
- Windows 7
- Windows Vista
- Windows XP
- Windows 2000