help-add

Generates a complete help package for 1C objects with a single command.

Updated Mar 29, 2026
One-click install
npx skills add https://github.com/Alex1980Alex/1C-Framework --skill help-add-alex1980alex
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: help-add
Source: https://github.com/Alex1980Alex/1C-Framework/tree/main/external/cc-1c-skills/.claude/skills/help-add
Command: npx skills add https://github.com/Alex1980Alex/1C-Framework --skill help-add-alex1980alex

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires lxml, and includes scripts (resource) components.

What problem does it solve?

This Skill removes the repetitive manual work of creating встроенную справку for 1C objects, so you can quickly add discoverable help pages without hand-editing metadata by trial and error.

Core Features & Use Cases

  • Help Package Generation: Creates the required Help.xml file and localized HTML help page for a chosen 1C object.
  • Form Metadata Update: Adds IncludeHelpInContents to form metadata when needed so help appears in the object contents automatically.
  • Support-State Safety: Checks whether the object is protected by vendor support rules before making changes, helping avoid edits that could break updates.
  • Use Case: Use it when you need to add built-in help to a catalog, document, report, or data processor and want a consistent file structure generated for you.

Quick Start

Ask the skill to add built-in help for your 1C object, specifying the object path and optional language if needed.

Frequently Asked Questions about help-add

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add built-in help to 1C configuration objects?

Adding built-in help to 1C objects involves generating a Help.xml file and a localized HTML page for the specified metadata object. The process requires an Ext directory and UTF-8 BOM output to ensure proper formatting.

How do I make 1C help appear in object form contents automatically?

To make help appear in 1C form contents automatically, update the form metadata by adding the IncludeHelpInContents parameter. This integrates the generated HTML help page directly into the object's form structure.

Can I add help to 1C objects that are under vendor support protection?

Adding help to 1C objects under vendor support protection requires checking the support-state first to avoid breaking updates. The process verifies support rules before applying any deterministic file edits to the metadata.

What 1C metadata objects support generated help packages?

1C metadata objects that support generated help packages include catalogs, documents, reports, and data processors. These objects require a structured help package with format-version detection and UTF-8 BOM output.

Do I need an Ext directory to generate Help.xml for 1C objects?

An Ext directory is required to generate Help.xml for 1C objects, along with format-version detection and UTF-8 BOM output. This directory structure ensures the help package integrates correctly with the metadata.