Create an Empty Project

Creating an empty project creates a project without any content. You can customize its settings according to your needs.

To create an empty project:

1. Click the Application Button at the upper-left of the Ribbon Menu.
2. Click New and then select Empty Project.
   
   
3. Enter a project name in the Project Name field.

   The project is created in the default directory, which is configurable in the Options Editor (Paths page). However, you can optionally choose a specific directory to save your project by browsing the Project Directory field.

4. Click Create.

The new empty documentation project is created and opened for edit. You can now add the Databases that you would like to document:

1. Click the Add Database button on the Project tab.
2. Use the displayed dialog to define the properties of the Database that you would like to document in this project.
3. Click Ok.

The selected Database is added to the Project Explorer under the Databases node. You can expand down through the database node to select / deselect individual database elements in order to include / exclude them from the generated output. Repeat the process above if you would like to include additional Databases in the project.

A Content File is created and added to the project under the Content Files node for each Database you add to the project. You can use this Content File to author additional content in the pages that Document! X automatically generates.

In Access and SQL Server you can use the various database item properties editors in Access or SQL Management Studio to author descriptions directly. In SQL Server you can also use the extended properties stored procedures to do this programmatically (see http://msdn.microsoft.com/en-us/library/ms190243.aspx).

See Author Content using the Content File Editor for authoring content outside of the source code.

Custom SQL Server Extended Properties

For SQL Server, you can define new Content Item Types in Document! X in order to store custom content types in extended properties - e.g. Author or Creation Date. The XML Tag Name of your custom Content Item Type is used to find the right extended property in SQL Server.

Tagged Source Comments

For database elements with source code (Views, Stored Procedures, Functions) you can also embed specifically tagged source comments that Document! X then uses in the generated output.

Example

-- ##SUMMARY This procedure is an example of using various Document! X comment types
-- ##REMARKS Single line and multi-line comments can be used
-- ##RETURNS Documents the return type of a procedure
CREATE PROCEDURE ExampleTaggedComments
@Param1 int = NULL, --##PARAM @Param1 The first parameter
@Param2 varchar, --##PARAM @Param2 The second parameter
@Param3 tinyint, --##PARAM @Param3 The third parameter
AS
...

XSL Transformation

HelpStudio supports transforming source comments and extended properties to HTML using XSLT. Using XSLT to transform your database content allows more complicated and structured source content, the output of which can be customized without making changes to the original content itself.

See Transforming Content Item Type Content for more information.

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.

To open the Content File Editor:

1. Expand the Content Files node on the Project Explorer.
2. Locate the Content File for the item you wish to author content for.
3. Right-click the Content File and select Edit.
4. The Content File opened for editing. The tree on the left side of the editor shows you a hierarchical view of the item you are documenting.
5. Drill down and select an item from the tree, the related documentation pages are shown on the right side of the editor.
6. Select a specific content type from the toolbar/vertical menu to edit a specific type of content, for example, Summary, See Also, and Keywords.
7. Type directly in the editable portions of the page on the right side of the editor.

Conceptual information is a key part of reference documentation, providing a high level introduction, tutorials, or other conceptual information. You can easily create conceptual topics in HelpStudio.

1. Click the New Topic button on the Project tab or use the Ctrl+T shortcut key.
2. The new Topic will be created in the currently-selected Topic Category on the Project Explorer (or under the (Un-categorized) node if no category is selected) and will be opened for edit.

   

3. Enter your conceptual content directly in the editable area of the Topic Editor.

You can find more information on Topic Editing in the Topic Editor topic.

The settings that govern Database Documentation generation are defined in the Build Profile editor. In a new project there is a single Build Profile but you can define many build profiles if you want to create multiple outputs with different settings.

To edit Database documentation settings:

1. On the Project Explorer, expand the Build Profiles node.
2. Double-click the required Build Profile to edit the properties.
   Alternatively, you can also right-click the required Build Profile and select Edit to open the Build Profile editor.

In the Build Profile editor, you can find the Database Settings page under the Reference Documentation section.

An essential part of delivering a complete documentation set is ensuring that all the items have been documented. Document! X includes the Undocumented Items tool to quickly and easily identify undocumented items.

1. On the Tools tab, select the Undocumented Items option.
2. Select the profile in the Project Profile field for which you want to find the undocumented items.
   If your project contains only one Build Profile then it appears in the Project Profile field by default.
3. Select Item Types, for example, Class, Method, Schema, and Column, that you want to check for undocumented items.
4. Select Content Types to indicate the items that must be considered documented (just Summary by default).
5. Select the Content Sources that should be used when checking for content.
6. Select Execute. Any undocumented items will be listed in the results grid.

Click the Build button on the Project tab to build your Database reference documentation.

Refer to the Deployment topic for more information on how to deploy your documentation to other machines.