Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions .github/agents/Assess-doc-impact.agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,9 +261,9 @@ The assessment report should contain:
| Input quality | Any doc impact | Complexity | Call to action |
|---|---|---|---|
| good | no (both) | — | No documentation impact identified for this ticket. |
| good | yes (either) | low or medium | Documentation changes are identified for this ticket. Run the Create DOC draft automation when the work for this ticket is done and validated by QA. The DOC agent will use JIRA context and code in related PRs as input. |
| good | yes (either) | high | Documentation changes with high complexity are identified for this ticket. Contact a writer in PCG to verify the documentation impact. |
| incomplete | — | — | More input is required to assess documentation impact. Add the missing input listed here to the ticket, and rerun the Assess DOC impact automation. |
| good | yes (either) | low or medium | Documentation changes are identified for this ticket. When the work for this ticket is done and validated by QA, run the Create DOC draft automation manually. It will create a DOC ticket, and then it will use JIRA context and code in related PRs as input to generate a first draft. For more information about the doc automations and how to run them, see https://alphahelp.qliktech.com/ld/en-US/edl/Content/EDL/Writing/Doc%20automation%20in%20Jira%20for%20dev%20teams.htm. |
| good | yes (either) | high | Documentation changes with high complexity are identified for this ticket. The documentation checklist item is now set to TO DO and the doc team can plan to work on it. There is no specific action for you at this time. |
| incomplete | — | — | More input is required to assess documentation impact. Add the missing input listed here to the ticket, and rerun the Assess DOC impact automation. For more information about the doc automations and how to run them, see https://alphahelp.qliktech.com/ld/en-US/edl/Content/EDL/Writing/Doc%20automation%20in%20Jira%20for%20dev%20teams.htm. |

#### Labels to apply

Expand All @@ -273,7 +273,8 @@ Apply documentation impact labels AND repository labels from Step 3.
|---|---|
| Both impacts = no | `DocImpact-no`, [repository labels from Step 3] |
| Either impact = yes, complexity = low or medium | `DocImpact-yes`, `DocAutomation-valid`, [repository labels from Step 3] |
| Either impact = yes, complexity = high or unknown | `DocImpact-yes`, [repository labels from Step 3] |
| Either impact = yes, complexity = high | `DocImpact-yes`, `DocComplexity-high`, [repository labels from Step 3] |
| Either impact = yes, complexity = unknown | `DocImpact-yes`, [repository labels from Step 3] |

#### TLV-specific checklist updates

Expand Down
58 changes: 31 additions & 27 deletions .github/skills/dita-variables/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ tags: ["dita", "conref", "product-names", "talend", "qlik"]

# DITA Variables Skill

**Last Verified:** 2026-10-20

## Scope

**DITA variables in docs-core means one thing:** `<keyword conref>` references to
Expand Down Expand Up @@ -64,17 +66,18 @@ the resolved text matches the table.
- If all values match: gate passes. Proceed with confidence.
- If any ID does not match or is missing: go to Step 4.

**Step 4: Handle discrepancy**

**Step 4: Handle discrepancy**
**Note**: All skill updates must be done in https://github.com/qlik-trial/help-content-tools/tree/main/.github/skills/dita-variables
1. Report:
```
VARIABLE AUDIT DISCREPANCY
ID: metadata-variables/NNN
Skill value: "<old product name>"
File value: "<new product name>" (metadata-variables.dita:<line>)
```
2. Update the reference table in this SKILL.md.
3. Update `Last Verified` to today.
2. Check out https://github.com/qlik-trial/help-content-tools/tree/main/.github/skills/dita-variables
2. Update the reference table in this https://github.com/qlik-trial/help-content-tools/blob/main/.github/skills/dita-variables/SKILL.md.
3. Still in that skill file, update `Last Verified` to today.
4. Create a new DDR file in `decisions/`.
5. Append the audit result to `profiles/` as a new timestamped entry.
6. Proceed using the value from metadata-variables.dita.
Expand All @@ -85,6 +88,7 @@ If no discrepancies were found, still:
- Update `Last Verified` to today.
- Append a pass entry to `profiles/` with timestamp and scope checked.

**Note**: All skill updates must be done in https://github.com/qlik-trial/help-content-tools/tree/main/.github/skills/dita-variables


**Gate failure mode:** If `metadata-variables.dita` cannot be read, stop.
Expand Down Expand Up @@ -140,39 +144,39 @@ The `Section` column identifies which `<section id="...">` in the file contains

| ID | Resolved Value | Section | Usage Context | Last Verified |
|---|---|---|---|---|
| `13` | Talend Cloud | Products_list | Generic name for the Talend Cloud SaaS platform; first choice for Talend Cloud references | 2026-06-29 |
| `183` | Talend Data Fabric | Products_list | On-premises platform product name | 2026-06-29 |
| `790` | Qlik Cloud | Products_list | Qlik Cloud platform references (post-acquisition branding) | 2026-06-29 |
| `794` | Qlik Talend Cloud | Products_list | Combined Qlik + Talend Cloud product name | 2026-06-29 |
| `785` | Qlik Talend Cloud Starter Edition | Products_list | Specific edition tier | 2026-06-29 |
| `786` | Qlik Talend Cloud Standard Edition | Products_list | Specific edition tier | 2026-06-29 |
| `787` | Qlik Talend Cloud Premium Edition | Products_list | Specific edition tier | 2026-06-29 |
| `788` | Qlik Talend Cloud Enterprise Edition | Products_list | Specific edition tier | 2026-06-29 |
| `13` | Talend Cloud | Products_list | Generic name for the Talend Cloud SaaS platform; first choice for Talend Cloud references | 2026-10-20 |
| `183` | Talend Data Fabric | Products_list | On-premises platform product name | 2026-10-20 |
| `790` | Qlik Cloud | Products_list | Qlik Cloud platform references (post-acquisition branding) | 2026-10-20 |
| `794` | Qlik Talend Cloud | Products_list | Combined Qlik + Talend Cloud product name | 2026-10-20 |
| `785` | Qlik Talend Cloud Starter Edition | Products_list | Specific edition tier | 2026-10-20 |
| `786` | Qlik Talend Cloud Standard Edition | Products_list | Specific edition tier | 2026-10-20 |
| `787` | Qlik Talend Cloud Premium Edition | Products_list | Specific edition tier | 2026-10-20 |
| `788` | Qlik Talend Cloud Enterprise Edition | Products_list | Specific edition tier | 2026-10-20 |

### Modules (engines, apps, components)

| ID | Resolved Value | Section | Usage Context | Last Verified |
|---|---|---|---|---|
| `42` | Talend Studio | Modules_list | Studio authoring environment; use for all Studio references | 2026-06-29 |
| `50` | Talend JobServer | Modules_list | On-premises job execution server | 2026-06-29 |
| `51` | Talend Runtime | Modules_list | ESB/OSGi runtime container | 2026-06-29 |
| `52` | Talend ESB | Modules_list | Enterprise Service Bus product/module | 2026-06-29 |
| `184` | Talend Integration Cloud | Modules_list | Legacy cloud integration module | 2026-06-29 |
| `185` | Talend Remote Engine | Modules_list | Remote Engine (non-Gen2) module | 2026-06-29 |
| `194` | Talend Cloud Pipeline Designer | Modules_list | Pipeline Designer cloud module | 2026-06-29 |
| `625` | Talend Management Console | Modules_list | TMC UI module; use for all TMC references in body text | 2026-06-29 |
| `641` | Talend Pipeline Designer | Modules_list | On-premises pipeline designer | 2026-06-29 |
| `642` | Remote Engine Gen2 | Modules_list | Second-generation Remote Engine | 2026-06-29 |
| `653` | Talend Data Catalog | Modules_list | Data Catalog module | 2026-06-29 |
| `677` | Dynamic Engine | Modules_list | Kubernetes-based Dynamic Engine; use for all Dynamic Engine references | 2026-06-29 |
| `729` | Qlik Talend Cloud Migration Toolkit | Modules_list | Migration toolkit module | 2026-06-29 |
| `42` | Talend Studio | Modules_list | Studio authoring environment; use for all Studio references | 2026-10-20 |
| `50` | Talend JobServer | Modules_list | On-premises job execution server | 2026-10-20 |
| `51` | Talend Runtime | Modules_list | ESB/OSGi runtime container | 2026-10-20 |
| `52` | Talend ESB | Modules_list | Enterprise Service Bus product/module | 2026-10-20 |
| `184` | Talend Integration Cloud | Modules_list | Legacy cloud integration module | 2026-10-20 |
| `185` | Talend Remote Engine | Modules_list | Remote Engine (non-Gen2) module | 2026-10-20 |
| `194` | Talend Cloud Pipeline Designer | Modules_list | Pipeline Designer cloud module | 2026-10-20 |
| `625` | Talend Management Console | Modules_list | TMC UI module; use for all TMC references in body text | 2026-10-20 |
| `641` | Talend Pipeline Designer | Modules_list | On-premises pipeline designer | 2026-10-20 |
| `642` | Remote Engine Gen2 | Modules_list | Second-generation Remote Engine | 2026-10-20 |
| `653` | Talend Data Catalog | Modules_list | Data Catalog module | 2026-10-20 |
| `677` | Dynamic Engine | Modules_list | Kubernetes-based Dynamic Engine; use for all Dynamic Engine references | 2026-10-20 |
| `729` | Qlik Talend Cloud Migration Toolkit | Modules_list | Migration toolkit module | 2026-10-20 |

### Resources (company / brand names)

| ID | Resolved Value | Section | Usage Context | Last Verified |
|---|---|---|---|---|
| `442` | Talend | Resources_list | Standalone "Talend" brand reference; use when referring to the company/brand, not a specific product | 2026-06-29 |
| `774` | Qlik | Resources_list | Standalone "Qlik" brand reference | 2026-06-29 |
| `442` | Talend | Resources_list | Standalone "Talend" brand reference; use when referring to the company/brand, not a specific product | 2026-10-20 |
| `774` | Qlik | Resources_list | Standalone "Qlik" brand reference | 2026-10-20 |

---

Expand Down
9 changes: 8 additions & 1 deletion .github/skills/dita-variables/profiles/2026-06-29-initial.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,11 @@ Usage examples confirmed in use across:

Hardcoded product names found in external `<xref href="">` anchor text across multiple
topics. The `conref` attribute cannot be placed
inside a `href` value but can be placed in the anchor text. No violations found in body prose for the high-frequency IDs.
inside a `href` value but can be placed in the anchor text. No violations found in body prose for the high-frequency IDs.

## Audit Gate Result: PASS (2026-10-19)

All 23 high-frequency IDs in the skill reference table were verified against
`common/taxonomy/metadata-variables.dita` using .NET XML parsing. No discrepancies
were found. ID 677 resolves to Dynamic Engine under topic ID `metadata-variables`.
This audit was required because the previous verification was more than 90 days old.
15 changes: 15 additions & 0 deletions .github/skills/dita-variables/profiles/2026-10-20-audit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# DITA Variables Skill - 2026-10-20 Audit

**Profile date:** 2026-10-20
**Audit result:** PASS
**Scope:** All 23 IDs in the High-Frequency ID Reference Table
**Source file:** `docs-core/common/taxonomy/metadata-variables.dita`

Each listed ID was located in the taxonomy source. Its resolved keyword text and
containing section match the skill reference table. No missing IDs or discrepancies
were found. The `Last Verified` date and all 23 table-entry verification dates were
updated to 2026-10-20.

**Products verified:** 13, 183, 790, 794, 785, 786, 787, 788
**Modules verified:** 42, 50, 51, 52, 184, 185, 194, 625, 641, 642, 653, 677, 729
**Resources verified:** 442, 774
Loading