Documator - Getting Started

Thank you for your interest in Documator. Documator brings our detailed pseudocode and flowchart design documenation to your build process. The simple but powerful command line application provides complete control over your detailed design documentation.

This guide will walk through the basic operation of Documator using some simple examples. They all use some predefined input files which can be downloaded here.

Generating documenation for various source files.

  1. Extract a fresh copy of the sample folder.
  2. Open a command prompt and move into the newly extracted "Sample" folder.
  3. Enter the command: documator
  4. Notice that no documentation has been generated. This is because there are no source files in the current folder.
  5. The -recursive option is required so that child folders are traversed.
  6. Try adding the -recursive option and running the command again.
  7. Documentation will be generated in the current folder in HTML format. You can try opening the index.html file.

Generating documenation for a single C# source file.

  1. Extract a fresh copy of the sample folder.
  2. Open a command prompt and move into the newly extracted "Sample" folder, and then the child "Source" folder.
  3. Enter the command: documator -input filename BinarySearch.cs
  4. Documentation will be generated in the current folder in HTML format. You can try opening the index.html file. The only code file included in the documentation will be BinarySearch.cs.

Generating documenation in Word format.

  1. Extract a fresh copy of the sample folder.
  2. Open a command prompt and move into the newly extracted "Sample" folder, and then the child "Source" folder.
  3. Enter the command: documator -format word
  4. Documentation will be generated in the current folder in Word format. It will be given the filename of the first source file (e.g. BinarySearch.cpp.doc).

Excluding C# source files.

  1. Extract a fresh copy of the sample folder.
  2. Open a command prompt and move into the newly extracted "Sample" folder, and then the child "Source" folder.
  3. Enter command: documator -exclude extension cs
  4. Documentation will be generated in the current folder in HTML format. You can try opening the index.html file. You will notice that BinarySearch.cs is excluded.

Specifying output filename.

  1. Extract a fresh copy of the sample folder.
  2. Open a command prompt and move into the newly extracted "Sample" folder, and then the child "Source" folder.
  3. Enter command: documator -output filename BinarySearchDocumentation.html
  4. Documentation will be generated in the current folder in HTML format. You can try opening the BinarySearchDocumentation.html file.

Also try experimenting with some different combinations of options. The full list of options can be seen by running documator -help from a command prompt or from the technical documentation section.