Documenting Your Project

As your Automise project gets larger and more complex typically the number of people maintaining the project grows. Typically this means documenting the intent of the scripts so everyone is on the same page. Here are some of the ways Automise lets you do that.

Topics covered:

• Action Groups
• Comment Actions
• Action Comments
• Variable Comments
• Project Information Remarks

Action Groups

Action groups are the best way to describe the purpose of a sequence of actions. It's clear to the reader exactly which actions are covered by the comment, and you can collapse the action group and still see roughly what it's doing.

To quickly create an action group, select a group of actions, right click, and choose "Refactoring | Wrap Actions with Action Group". Then press F2 to give the action group a meaningful name.

Comment Actions

Comment actions are useful for providing further information about a part of your build. They draw the maintainer's attention to some important information about a part of the build. It's also good practice to place a comment at the start of each Target (apart from Main), describing the purpose of the Target and its parameters.

Action Comments

Finally, actions themselves can have comments. These are useful for explaining the rationale behind a specific action or option, or to warn the maintainer about any important side effects.

Variable Comments

While system variables come with predefined comments, it's up to your to document your own variables using the Comment field. Good comments explain what a variable is used for, where its value comes from, and what a typical value looks like.

Project Information Remarks

The project itself has remarks that can be edited on the Project Information page. This field is by default shown on the Welcome Page. You can put a brief summary of the purpose of the project, and possibly some history or other remarks.