If you would like to create free format Topics in addition to those generated by Document! X and HelpStudio automatically, you can do so using the Topic Editor. The Topic Editor allows you to manually author free format content such as tutorials, getting started guides and task focused help.

The Topic Fundamentals topic covers the basics of working with Topics and using the Topic Editor.

Movies

 

Document! X and HelpStudio includes a specific tool for authoring Glossary Content.

Terms you define in the Glossary Editor are output to a structured Glossary topic in the generated output and the terms you define can be referenced in your content by surrounding them with $ $ symbols - e.g. $ $MyGlossaryTerm$ $. Glossary references in your content are replaced in the generated output by popup definitions for the referenced term. Example: Build Flag

You can learn more about authoring Glossary Content in the Glossary Editing topic.

 

Document! X and HelpStudio includes a Visual Comment Editor integrated with Visual Studio 2015, 2017 and 2019. The Visual Comment Editor makes it easy to author, review and edit content that you want to store as Xml format source comments in .NET source code.

Movies

 

If you would like to supplement the content of the pages automatically generated by Document! X and HelpStudio outside of the source code, you can do so using the Document! X and HelpStudio Content File Editor. The Content File Editor allows you to review and author content for any item for which a reference documentation page is generated.

Movies

 

AutoDoc is a powerful Document! X feature that allows you to author content that is used in the generated output according to rules that you define. For example you might want to author some specific remarks for inclusion in every method with a particular name in order to prevent duplicating the same content in many places.

The AutoDoc overview topic contains more information about the AutoDoc feature.

Movies