Index of every page on this site: llms.txt
All skills
arman-kudaibergenov avatar

/help-add

@92d389e
by Arman Kudaibergenovarman-kudaibergenov/1c-ai-development-kit166 stars
20
Run it yourself

Этот скилл MUST быть вызван когда нужно добавить встроенную справку к объекту 1С: обработка, отчёт, справочник, документ. SHOULD также вызывать когда документация объекта должна быть встроена в конфигурацию. Do NOT использовать для создания внешней документации или README.

Requires /form-add
Use this Skill: https://skilld.dev/gh/arman-kudaibergenov/1c-ai-development-kit/help-add

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈123 tokens for metadata: the name and description. ≈1k when used: this file.

Description uses 3.5% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈284 characters, or 3.5%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

/help-add — Добавление справки

Добавляет встроенную справку к объекту: файл метаданных Help.xml, HTML-страницу и при необходимости обновляет метаданные форм.

Usage

/help-add <ObjectName> [Lang] [SrcDir]
Параметр Обязательный По умолчанию Описание
ObjectName да — Имя объекта
Lang нет ru Код языка справки
SrcDir нет src Каталог исходников

Команда

powershell.exe -NoProfile -File .claude/skills/help-add/scripts/add-help.ps1 -ObjectName "<ObjectName>" [-Lang "<Lang>"] [-SrcDir "<SrcDir>"]

Что создаётся

<SrcDir>/<ObjectName>/
    Ext/
        Help.xml                    # Метаданные справки (namespace extrnprops)
        Help/
            ru.html                 # HTML-страница справки
  • Help.xml — фиксированная структура с <Page>ru</Page> (namespace http://v8.1c.ru/8.3/xcf/extrnprops)
  • ru.html — HTML 4.0 Transitional с подключением стилей 1С (v8help://service_book/service_style)
  • Справка не регистрируется в ChildObjects корневого XML — достаточно наличия файлов

Что модифицируется

  • Если в метаданных формы (Forms/<FormName>.xml) отсутствует <IncludeHelpInContents> — скрипт добавит <IncludeHelpInContents>false</IncludeHelpInContents> после <FormType>. Для форм, созданных через /form-add, элемент уже есть.

Кнопка справки на форме

После создания справки для её вызова нужна кнопка на форме. Добавь кнопку Form.StandardCommand.Help в AutoCommandBar формы (Forms/<FormName>/Ext/Form.xml).

Текущая структура AutoCommandBar (созданная form-add)

<AutoCommandBar name="ФормаКоманднаяПанель" id="-1">
    <Autofill>true</Autofill>
</AutoCommandBar>

Нужно заменить на

<AutoCommandBar name="ФормаКоманднаяПанель" id="-1">
    <Autofill>true</Autofill>
    <ChildItems>
        <Button name="ФормаСправка" id="{{свободный_id}}">
            <Type>CommandBarButton</Type>
            <CommandName>Form.StandardCommand.Help</CommandName>
            <ExtendedTooltip name="ФормаСправкаExtendedTooltip" id="{{свободный_id + 1}}"/>
        </Button>
    </ChildItems>
</AutoCommandBar>

Выбор id

Просмотри все id="..." в Form.xml и выбери следующий свободный числовой id. Обычно id начинаются с 1 и идут подряд. Для кнопки нужны 2 id: один для Button, один для ExtendedTooltip.

Важно

  • Form.StandardCommand.Help — стандартная команда платформы, не нужно объявлять в <Commands>
  • Обработчика в Module.bsl не требуется — платформа сама найдёт Help.xml и откроет HTML

Редактирование справки

После создания содержимое справки — обычный HTML. Отредактируй Ext/Help/ru.html в соответствии с назначением объекта. Поддерживается стандартная HTML-разметка: <h1>..<h4>, <p>, <ul>, <ol>, <table>, <strong>, <em>, <a>, <pre>.

Source: SKILL.md on GitHub

Skill behaviors

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

Third-party checks

No alerts7mo4 checks · Risk SAFE
  • Gen Agent Trust Hub7mo

    The skill is a utility for 1C platform development that automates the creation of help files and updates form metadata. It operates entirely on the local file system using PowerShell scripts to perform XML and HTML manipulations. While no malicious behavior was detected, the script does not sanitize the 'ObjectName' input, which could allow for path traversal or HTML injection in the generated files if provided with malicious arguments.

  • Socket7mo

    No alerts

  • Snyk7mo

    Risk: LOW · No issues

  • Runlayer7mo

    1/2 files flagged

Provenance

Signed by skilld at 92d389e. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub last week.

Steadyupdated 8 months ago

Capability

What it can do
Runs commands Reads files Edits files
argument-hint
<ObjectName>
All 6 allowed tools
BashReadWriteEditGlobGrep

README badge

README badge for arman-kudaibergenov/1c-ai-development-kit/help-add