DOC

Create Markdown documentation and process UML diagrams

Create documentation for the specified components.

bc create doc {Source}

COMP DOC Arguments

Documenting a single Component

bc COMP DOC /c {yourComponentId}

The simplest form of creating documentation is to document a single component. The documentation is created in the Markdown format and stored in the Out/Doc folder.

You can preview Markdown documents directly in Visual Studio Code:

609KB

processDoc.pdf

pdf

An PDF example containing a process documentation (printed Markdown)

Documenting a Packaged Component

By using the Common Arguments or Common Arguments arguments you can quickly document a packaged component. This will also create a nice readMe file for the package content.

.\doc\_packageVersions\2024-07-23-msc.01m.md