Modules
Overview
Modules provide a top-level map of the product by grouping related content into broad areas such as Reports, Skills, and Admin. Each module record summarizes the area with these fields: Name, Display label, Intended audience, File count, and Representative sample files. Use Modules to identify where a topic, file, or piece of documentation belongs before you drill into feature-level help.
Modules are a classification layer, not a task workspace. They help you recognize broad product areas, compare domains at a glance, and trace content back to the right part of the system.
When to use Modules
Open Modules when you need orientation or to decide where to place content.
- To get a structured list of the main product areas before opening feature documentation
- To categorize help topics, support notes, or internal materials by product area
- To check which user group a module is primarily associated with
- To compare broad areas such as Reports, Skills, and Admin
- To find example files that illustrate what belongs in a module
- To onboard a new team member to the product landscape
How it works
Review the module list for a high-level map
Open the Modules list to see the product’s major areas. Use the list as an inventory of domains that organize the system and to decide which area to inspect next.
Open a module record to confirm the area
Open the module record and check Name and Display label to confirm the product area and the user-facing label.
Check the Intended audience
Review Intended audience to understand who the module serves (for example, admins, end users, or developers). Use that field to determine whether documentation or training should target a specific group.
Use File count as a scope signal
Use File count as a quick indicator of how much material is associated with the module. Treat it as a rough scope signal, not a completeness metric.
Use representative sample files to place content correctly
Compare your file, article, or support note to the Representative sample files shown in the module to decide whether it belongs there. Sample files provide practical context to guide categorization.
Typical workflow
- Open the Modules list to get a broad view of product areas.
- Scan the list and select the module that best matches your topic or business question.
- Open the module record and confirm the Name and Display label.
- Check Intended audience to determine relevance and ownership.
- Review File count to gauge the amount of associated material.
- Inspect Representative sample files to match your item against examples.
- Place your topic under the module that best matches the domain, then continue into the detailed help content for that area.
Example: To assign a troubleshooting article, compare Reports and Admin, confirm the display labels and intended audiences, review sample files, and assign the article to the module whose examples and audience match the problem domain.
Fields, controls, or options you may see
| Field | What it tells you | How to use it |
|---|---|---|
| Name | The primary internal identifier for the module | Use it to recognize the product area in lists and records |
| Display label | The user-friendly label shown to readers | Use it when matching business or customer language to product areas |
| Intended audience | The user group associated with the module | Use it to decide relevance, ownership, and training targets |
| File count | Number of files or items tied to the module | Use it as a rough scope indicator when comparing modules |
| Representative sample files | Example files or content tied to the module | Use them to verify whether a topic fits the module |
Related skills or automation
Modules classify content and help you decide where automation, skills, or configuration topics belong. For automation or skill-specific details, open the Skills module or the relevant module (for example, Admin) to find feature-level documentation and operational steps.
Things to watch for
- Modules are for orientation and classification, not detailed task instructions.
- A module represents a broad domain; it does not list every feature or screen.
- Treat File count as a summary signal, not a measure of complexity or completeness.
- Representative sample files are examples, not a complete inventory.
- For exact setup steps or operational actions, open the module and follow links to the specific feature or help topic.