DocGen Web Header

Introduction

DocGen v3 is an AutoCAD based application for automatically generating documentation of EDA packages. All the intelligence needed to create documentation is contained within AutoCAD drawing template files generated by DocGen. The template file is combined with a design drawing by DocGen, which then assists the user to quickly and accurately complete the documentation values and embedded images and reports. DocGen is launched from an AutoCAD custom menu:




DocGen Menu


DocGen Template Creation

The DocGen Template module is the starting point for making an AutoCAD drawing available as a template for documentation. It consists of three key ideas:
1) Defining the design boundary
2) Defining sheet layer sets
3) Defining text variables




DocGen Template


Design Boundary

The design boundary indicates the location of the AutoCAD drawing representing the finished EDA design. The design drawing is always positioned with its scale preserved, and the template drawing is scaled around it. This boundary defines how this transformation takes place and ensures that the design is placed optimally within the documentation.
The DocGen Template function prompts the user to select a single zero with close polyline representing the design boundary. This information is then stored within the drawing, as with all other template defined data.



Sheet Layer Sets

Documentation is broken down into sheet layer sets, or simply sheets. These sheets are named groups of layers which logically combine together to represent a view of the documentation.

The DocGen Sheet Manager lets the user define named sheets and select existing layers in the template drawing and add layers which will be in the design drawing. When used for completing the documentation of a specific design, the sheets become a critical way to filter, view and edit the document values. All sheet layer set data is stored in the template drawing.




Sheet Layer Sets


DocGen Text Manager

The DocGen Text Manager is key to identifying the text elements in the template which correspond to documentation values. The user simply uses the familiar AutoCAD entity selection on screen to pick any text object. No special formatting or prefix is needed to identify DocGen text variables as all storage and identification is achieved via hidden XData.

The Text Manager will scan to the left of the selected text to fill in values for the text label and description. If no label is present then the description can be filled out manually to provide meaning.

The user can assign a default value for the text, which could represent a measurement, a material, or other standard value used in the technology.

A sheet name, defined in the Sheet Manger can be assigned (or entered) and an optional table, which represents a subset of a sheet, typically within one grouped area. A list of all tagged text variables is listed in the Text Manager, which can be filtered by sheet and/or layer. Double-clicking a row in the grid will zoom and select the text entity for easy verification.




DocGen Text Manager

Once all text variables have been identified, saving the drawing completes the creation of the self-contained DocGen template.
The DocGen template drawing only needs to be created and saved one time. Then it can be reused any number of times for the same technology. Because the intelligence defining the technology is self-contained within the drawing file, it is easy to clone and edit DocGen template drawings as processes change, or new technologies need to be supported.



Main DocGen Module

The main DocGen module, selected from the top of the AutoCAD DocGen menu in a new drawing, is how a DocGen document drawing is created. Simply select the template and design files. By default, the template will be scaled around the design drawing. But offset and scaling parameters can be set if the drawings use different reference points.

When OK is clicked, the design drawing is inserted at scale, the template drawing is positioned around the design, and all default parameters for text variables are initialized to those defined in the template. The DocGen Document module is then displayed to the user, to complete the documentation process.




Main DocGen Module


DocGen Document

The DocGen Document module is made visible after the main DocGen module is run, and can be opened at any time from the DocGen menu, when editing a document drawing.

The DocGen Document palette displays the predefined sheets and tables and the text variables that belong to them. Each sheet and table can be selected in turn and symbols indicate when a sheet or text has been reviewed or edited, to assist the user in reviewing all required document data.
As each sheet is selected, only the layers belonging to that sheet layer set are made visible, so that the user can view only the parts of the documentation being edited. Double-clicking a row in the text grid zooms to the text entity for verification. The document values can be changed as many times as needed, and it does not matter if any text values have empty values, since they can be identified from their attached XData.

Once the text variables have all been updated as needed, the document drawing can be saved.



DocGen Document


DocGen Video Tutorial

The video tutorial shows how to get started using DocGen from Artwork Conversion Software. The tutorial demonstrates how to create and use a document template in AutoCAD 2025. The DocGen plugin is designed to automate creation of documentation for EDA designs.