Testing the /article-voice skill (voice:spolski)#82
Testing the /article-voice skill (voice:spolski)#82serhiipylypchuk1991 wants to merge 4 commits intomasterfrom
Conversation
| - *Refer to the [**Working with data**](guides/working_with_data.md) section for details!* | ||
| Kanban has three configurable areas: **Cards** (what each card shows), **Editor** (what fields appear when you open a card), and **Toolbar** (the controls above the board). | ||
|
|
||
| Cards and Editor are linked by key names. A field on a card maps to an editor control through a shared `key`. If the keys don't match, the editor control won't update the card field. This is the one thing that trips most people up when customizing both at the same time. |
There was a problem hiding this comment.
trips most people up - в тех доках не должно быть phrasal verbs, особенно conversional style
There was a problem hiding this comment.
Я бы даже сказал что стиль изложения слишком свободен. Для документации нам нужен более строгий стиль
| ## Cards | ||
|
|
||
| The board of Kanban consists of the *cards* distributed into *columns* and *rows*. You can configure the cards appearance using the [`cardShape`](api/config/js_kanban_cardshape_config.md) configuration property. There are several predefined fields you can include (or exclude) into the card template, namely: | ||
| Use [`cardShape`](api/config/js_kanban_cardshape_config.md) to control which fields appear on each card. Set a field to `true` to show it, `false` (or omit it) to hide it. |
There was a problem hiding this comment.
Оригинал дает больше информации пользователю, особенно тем, кто имеет дело с kanban впервые.
There was a problem hiding this comment.
Согласен! Нужно сравнить еще с voice:idra
There was a problem hiding this comment.
Первое предложение в целом норм, но второе делает винегрет
|
|
||
| :::tip | ||
| You can manage the **label** and **description** fields of any card via the corresponding inputs of the Kanban editor. If you activate these fields, the corresponding inputs will be displayed in the editor automatically. To configure these inputs, you can use the [**text** and **textarea**](#text-and-textarea-types) types. | ||
| Managed via the **label** input in the editor. Enable it here and the input appears automatically. Configure it with the [text or textarea](#text-and-textarea-types) editor type. |
There was a problem hiding this comment.
Managed - активный залог всегда предпочтительнее для понимания и восприятия (You can manage)
Конструкци в оригинале To do X, do ...также более акцентирует внимание юзера на том, что и зачем ему нужно делать.
А также нужно прописать, чтобы ИИ:
Vary sentence structure:
"To show this, do this"
"Use expectedType to filter rows by data type"
Потому что одна и та же структура предложений повторяется.
У меня есть кастомизированный скилл для гайдов, который дополнен мною здесь (https://tracker.webix.io/issue/SVAR-2874/Improve-article-write-skills-for-AI )- там есть эти инструкции для ИИ (в аттаче - article-voice-guide), чтобы он этому следовал
There was a problem hiding this comment.
Одна из основных опций которую нужно поправить - минимизация пассива и герундия. Нужно переходить на актив, и использовать только present simple для технических текстов
В некоторых случаях, где контент маркетинговый, можно использовать более свободную форму изложения
|
|
||
| :::tip | ||
| You can manage the **progress** field of any card via the corresponding control of the Kanban editor. If you activate this field, the corresponding control will be displayed in the editor automatically. To configure this control, you can use the [**progress**](#progress-type) type. | ||
| Managed via the **description** input in the editor. Configure it with the [text or textarea](#text-and-textarea-types) editor type. |
|
|
||
| :::note | ||
| Unless you specify the card settings via the [`cardShape`](api/config/js_kanban_cardshape_config.md) property, the widget will apply a [**defaultCardShape**](api/config/js_kanban_cardshape_config.md#default-config) set of parameters! | ||
| If you don't set `cardShape`, the widget uses [**defaultCardShape**](api/config/js_kanban_cardshape_config.md#default-config). |
There was a problem hiding this comment.
Конструкции с unless лучше не допускать в тех доках, т.к. могут вызывать разночтения.
There was a problem hiding this comment.
| # DHTMLX Kanban overview | ||
|
|
||
| JavaScript Kanban is an effective solution for the workflow visualization. The widget helps you better understand your business processes and gain an overview of your team workload. This flexible tool can work with any number of cards, columns and swimlanes. Fully written in pure JavaScript and CSS, the component can be easily set and customized as well as integrated into any web app or web page. | ||
| DHTMLX Kanban is a JavaScript widget for building Kanban boards. No framework required — just a JS file and a CSS file. |
There was a problem hiding this comment.
Для overview по-хорошему нужен отдельный скилл или инструкция внутри guide.
В overview нужно детальное описание виджета как в оригинале
There was a problem hiding this comment.
Да, и инструкции должны быть с упором на маркетинговый контент, где язык более свободный и менее техничный
| - select multiple cards using the following shortcuts: | ||
| - `Shift` + clicking on the corresponding cards, to select multiple cards in the same column | ||
| - `Ctrl (Command)` + clicking on the corresponding cards, to select multiple cards in different columns | ||
| The **Board** is the main working area. Cards are organized into columns (stages) and rows (swimlanes). Card appearance is configurable — you can use predefined fields or replace the default template entirely. See [Configuration → Cards](guides/configuration.md#cards). |
There was a problem hiding this comment.
Первые два предложения взяла бы от ИИ. Далее - оригинал.
The Board is the main working area. Cards are organized into columns (stages) and rows (swimlanes).
You can flexibly configure the cards appearance as well as apply a custom template. Read more in the Configuration section.
Список (и айтемы) у ИИ более компактно описан
| ### Editor | ||
|
|
||
| The **Editor** is a modal panel that consists of the fields and controls for managing the selected card data. To display the editor, click on the card you want to change. You can flexibly configure the editor structure by adding new fields and controls. Read more in the [Configuration](guides/configuration.md#editor) section. | ||
| The **Editor** opens when you click a card. It shows the fields for that card's data. |
There was a problem hiding this comment.
Снова ИИ опускает описательную нужную инфу The Editor is a modal panel that consists of the fields and controls for managing the selected card data.
There was a problem hiding this comment.
Ну правды ради нужно сказать, что в оригинале этой инфы тоже нет. То что там написано modal это еще ничего не значит. Хорошо было би написать здесь про 2 режима эдитора и показать их соответственно на скине
| ::: | ||
|
|
||
| The *Editor* of Kanban consists of the fields for managing the cards data. To configure the editor fields (controls), you can use the [`editorShape`](api/config/js_kanban_editorshape_config.md) property. You can use the following types of editor fields: | ||
| Use [`editorShape`](api/config/js_kanban_editorshape_config.md) to define which controls appear in the editor. Each control has a `type`, a `key` that links it to the corresponding card field, and a `label`. |
There was a problem hiding this comment.
мне не нравится использование it, поскольку очень часто не совсем понятно к чему он относится и приходится перечитывать абзац еще раз чтобы уловить контекст
|
|
||
| :::info | ||
| If you want to use trial version of Kanban, download the [**trial Kanban package**](https://dhtmlx.com/docs/products/dhtmlxKanban/download.shtml) and follow steps mentioned in the *README* file. Note that trial Kanban is available 30 days only. | ||
| **Trial version:** Download the [**trial Kanban package**](https://dhtmlx.com/docs/products/dhtmlxKanban/download.shtml) and follow the *README*. Valid for 30 days. |
There was a problem hiding this comment.
Здесь можно компактный вариант ИИ принять. Т.к. сами по себе "If you want //" фразы не несут доп смысла
There was a problem hiding this comment.
Не, агент убирает структуру с розбитием на заголовки, которые используются в документации в качестве якорей. И в целом разбитие контента на подсекции улучшает восприятие контента
There was a problem hiding this comment.
а мне еще Valid for не нравится) Не маркетинговая фраза получается
| - [`editor`](api/config/js_kanban_editor_config.md) — editor behavior (autosave, etc.) | ||
| - [`cardTemplate`](api/config/js_kanban_cardtemplate_config.md) — custom card rendering → see [Customization](guides/customization.md) | ||
| - [`locale`](api/config/js_kanban_locale_config.md) — localization → see [Localization](guides/localization.md) | ||
| - [`cards`](api/config/js_kanban_cards_config.md), [`columns`](api/config/js_kanban_columns_config.md), [`rows`](api/config/js_kanban_rows_config.md), [`links`](api/config/js_kanban_links_config.md) — data → see [Working with data](guides/working_with_data.md) |
|
|
||
| :::tip | ||
| You can manage the **start date** and **end date** fields of any card via the corresponding controls of the Kanban editor. If you activate these fields, the corresponding controls will be displayed in the editor automatically. To configure these controls, you can use the [**date**](#date-and-daterange-types) type. | ||
| Managed via the **progress** control in the editor. Configure it with the [progress](#progress-type) editor type. |
There was a problem hiding this comment.
(-) тоже не совсем правильно. idra дает лучший результат https://github.com/DHTMLX/docs-kanban/pull/83/changes#diff-7174c092c6ae1e7b14c766db2501547b5b20f45e207257d04ee5d649322f94d3R41
| - a card context menu via the `menu: boolean` config | ||
| - a card attachment via the `attached: boolean` config | ||
| - `start_date: boolean` — start date | ||
| - `end_date: boolean` — end date |
There was a problem hiding this comment.
не хватает призыва к действию
There was a problem hiding this comment.
Вроде здесь просто перечислены доступные поля
|
|
||
| :::tip | ||
| You can **attache files** to any card via the corresponding field of the Kanban editor. To configure this field, you can use the [**files**](#files-type) type. | ||
| Managed via date controls in the editor. Configure them with the [date](#date-and-daterange-types) editor type. |
|
|
||
| :::tip | ||
| You can assign one or several users to any card via the corresponding control of the Kanban editor. To configure the control for assigning a single user, use the [**combo** or **select**](#combo-select-and-multiselect-types) types of editor. To assign multiple users, use the [**multiselect**](#combo-select-and-multiselect-types) type. | ||
| Managed via a color picker in the editor. If enabled, the picker appears automatically. Configure it with the [color](#color-type) editor type. |
There was a problem hiding this comment.
опять! spolski делает однотипные ошибки
| - `priority: boolean | { show: boolean, values: object }` — priority badge | ||
|
|
||
| :::tip | ||
| Managed via the editor. If enabled, the control appears automatically. Configure it with the [combo or select](#combo-select-and-multiselect-types) types only. |
There was a problem hiding this comment.
аналогично!
| - [**progress**](#progress-type) | ||
| - [**files**](#files-type) | ||
| - [**date** and **dataRange**](#date-and-daterange-types) | ||
| - [**date** and **dateRange**](#date-and-daterange-types) |
There was a problem hiding this comment.
правит опечатки) какой молодец!
| :::info | ||
| For the editor field of **"multiselect"** and **"combo"** types you can also specify a path to the preview image via the **avatar** property: | ||
| `multiselect` and `combo` also support an `avatar` property for preview images: | ||
|
|
There was a problem hiding this comment.
Оригинал мне кажется выглядит лучше
| ### Files type | ||
|
|
||
| The editor field of **files** type can be set in the following way: | ||
| Use `files` to let users attach files to a card. You can provide the upload URL as a string or as a function for custom request handling. |
There was a problem hiding this comment.
здесь прям удачно актив используется, хотя вторая часть предложения немного запутанная
There was a problem hiding this comment.
Вроде вторая часть довольно понятная, она суммирует подзаголовки ниже
| ~~~ | ||
|
|
||
| You can manage (*hide/show/customize*) the Toolbar controls using the **items** property: | ||
| Use the `items` array to control which controls appear, in what order. Remove a string to hide that control. Pass an object instead of a string to customize it: |
There was a problem hiding this comment.
control which controls - та же проблема что и в idra - https://github.com/DHTMLX/docs-kanban/pull/83/changes#r3013851187
| - *kanban.js* | ||
| - *kanban.css* | ||
|
|
||
| Make sure that you set correct relative paths to the source files: |
There was a problem hiding this comment.
Важная нота которую агент просто убрал...
There was a problem hiding this comment.
А, не убрал, а просто переписал и перенес в низ кода, что не совсем правильно
| ## Creating container | ||
|
|
||
| Add a container for Kanban and give it an ID, for example *"root"*: | ||
| Add a `div` for the board: |
There was a problem hiding this comment.
все таки контейнер!
There was a problem hiding this comment.
Оригинал лучше в этой ситуации
|
|
||
| - an HTML container (the ID of the HTML container) | ||
| - an object with configuration properties | ||
| To add the Toolbar, initialize it separately and pass `board.api` so it can communicate with the board: |
There was a problem hiding this comment.
Сомнительно но ОК
There was a problem hiding this comment.
В оригинале есть список этих параметров, что воспринимается лучше
There was a problem hiding this comment.
Как минимум, не хватает названия конструктора kanban.Toolbar
| ~~~ | ||
|
|
||
| :::info | ||
| To learn more about configuring the Toolbar of Kanban, read the [**Configuration**](guides/configuration.md/#toolbar) section |
There was a problem hiding this comment.
Оригинал описывает лучше, хот чуть длиннее! Переписанная версия обрезает контекст
| Start from creating an HTML file and call it *index.html*. Then proceed to include Kanban source files into the created file. | ||
| ## Step 1. Include source files | ||
|
|
||
| There are two necessary files: |
There was a problem hiding this comment.
здесь я бы тоже оставил как есть
| ~~~ | ||
|
|
||
| :::info | ||
| The Toolbar is an optional part of the Kanban interface. To create Kanban without Toolbar, you can specify only one DIV container and initialize the widget via the **kanban.Kanban** constructor |
There was a problem hiding this comment.
Эта важная нота была удалена (
| // configuration properties | ||
| }); | ||
| ~~~jsx {2-4,6-8} title="index.html" | ||
| const board = new kanban.Kanban("#root", { |
There was a problem hiding this comment.
ну нормально так сниппет обрезал...
| - `Ctrl (Command)` + clicking on the corresponding cards, to select multiple cards in different columns | ||
| The **Board** is the main working area. Cards are organized into columns (stages) and rows (swimlanes). Card appearance is configurable — you can use predefined fields or replace the default template entirely. See [Configuration → Cards](guides/configuration.md#cards). | ||
|
|
||
| On the board you can: |
There was a problem hiding this comment.
здесь сокращение оправдано
| ### Color type | ||
|
|
||
| The editor field of **color** type can be set in the following way: | ||
| Use `color` to let users pick a color for the card's top bar: |
There was a problem hiding this comment.
Я прогоняла (не на kanban), - и промт вносила в свой скилл- переделанный с article-write (guide), ИИ следует инструкциям
| # Initialization | ||
|
|
||
| This guide will give you detailed instructions on how to create Kanban on a page to enrich your application with features of the Kanban board. Take the following steps to get a ready-to-use component: | ||
| There are two constructors: `kanban.Kanban` for the board itself, and `kanban.Toolbar` for the control bar above it. Both take the same two arguments: a container ID and a configuration object. The Toolbar is optional — and it needs a reference to the board's `api` to know which board it controls. |
There was a problem hiding this comment.
Да, согласна. Поэтому и написала, что нужно, видимо, прописать в скилле - оставлять summary в начале старницы
| <link rel="stylesheet" href="./dist/kanban.css"> | ||
| ~~~ | ||
|
|
||
| Check that the paths point to the right location in your `dist` folder. |
There was a problem hiding this comment.
Аналогично в idra - делает коммент после кода - https://github.com/DHTMLX/docs-kanban/pull/83/changes#r3015232204
| ~~~ | ||
|
|
||
| If you want to create the widget along with its *Toolbar*, you need to add a separate container for it: | ||
| If you're using the Toolbar, it needs its own container — it renders outside the board: |
There was a problem hiding this comment.
Да, и в idra тоже present continuous
|
|
||
| ### Comments type | ||
|
|
||
| The editor field of **comments** type can be set in the following way: |
There was a problem hiding this comment.
А здесь просто удалило строку?
|
|
||
| ### Links type | ||
|
|
||
| The editor field of **links** type can be set in the following way: |
|
|
||
| ## Example | ||
|
|
||
| In this snippet you can see how to configure the **Cards**, **Editor** and **Toolbar** of Kanban: |
There was a problem hiding this comment.
здесь, кажется, тоже строку удалило
| This clear and comprehensive tutorial will guide your through the steps you need to take in order to get a full-functional Kanban on a page. | ||
| This guide covers the minimum setup to get a working Kanban board on a page. | ||
|
|
||
| There are two constructors: `kanban.Kanban` for the board, and `kanban.Toolbar` for the toolbar above it. Each needs its own container. The Toolbar is optional — if you don't need search and sorting controls, skip it entirely. |
There was a problem hiding this comment.
Интересно, что здесь добавил инфо про конструкторы. Но в конце добавил тире, можно было бы заменить двоеточием здесь
|
|
||
| :::info | ||
| You can access the DHTMLX private **npm** directly in the [Client's Area](https://dhtmlx.com/clients/) by generating your login and password for **npm**. A detailed installation guide is also available there. Please note that access to the private **npm** is available only while your proprietary Kanban license is active. | ||
| **PRO version:** Log into the [Client's Area](https://dhtmlx.com/clients/) to generate credentials for the DHTMLX private **npm** registry. Access requires an active license. |
There was a problem hiding this comment.
Здесь тоже, кажется, текст был от маркетинга
| ## What's next | ||
|
|
||
| Now you can get down to using Kanban in your application. Follow the directions of the [How to start](how_to_start.md) tutorial for guidance. | ||
| To put a board on a page, start with [How to start](how_to_start.md). |
There was a problem hiding this comment.
Как-то здесь очень сокращенно получилось. Для гайда оригинал лучше
| The **Editor** is a modal panel that consists of the fields and controls for managing the selected card data. To display the editor, click on the card you want to change. You can flexibly configure the editor structure by adding new fields and controls. Read more in the [Configuration](guides/configuration.md#editor) section. | ||
| The **Editor** opens when you click a card. It shows the fields for that card's data. | ||
|
|
||
| By default it renders whatever fields you've enabled in `cardShape`. You can add more fields and controls on top of that. See [Configuration → Editor](guides/configuration.md#editor). |
There was a problem hiding this comment.
Мне кажется, whatever не очень уместно в техническом описании, можно даже просто артиклем the заменить: the fields you've enabled
3 participants
No description provided.