Правка документации

README.md

@@ -1,28 +1,20 @@
 # Дымовые тесты для 1С и вывод результата в отчет Allure
 
 Видео примеры:
-- <a href="https://youtu.be/NzB2dIhH08s" target="_blank">VanessaADD. Дымовые тесты для 1С и вывод результата в отчет Allure. Проверяем доработки в расширение</a>
 - <a href="https://youtu.be/hVGjl_lW4Pg" target="_blank">VanessaRunner. Проверяем доработки после обновления с помощью внешней обработки</a>
 
 [![telegram](https://img.shields.io/badge/telegram-chat-green.svg)](http://t.me/ovmst)
 
-- [Задача](#задача)
 - [Установка](#установка)
 - [Создание проекта](#создание-проекта)
+- [Описание команд](#описание-команд)
+- [Групповая проверка доработок](#групповая-проверка-доработок)
 - [Дымовые тесты](#дымовые-тесты)
 - [Информация о поддержке метаданных](#информация-о-поддержке-метаданных)  
-- [Групповая проверка доработок](#групповая-проверка-доработок)
 - [Синтаксическая проверка](#синтаксическая-проверка)
-- [Описание команд](#описание-команд)
 - [Проверка кода](#проверка-кода)
 - [Дополнительные материалы](#доп-материалы)
 
-<a id="markdown-задача" name="#задача"></a>
-
-## Задача
-
-Автоматизировать процесс проверки сделанных доработок. Сократить время на настройку и выполнения тестов за счет точечной настройки. Результаты тестирования вывести в отчет Allure.
-
 <a id="markdown-установка" name="#установка"></a>
 
 ## Установка
@@ -47,62 +39,20 @@
 
 При создании проекта сразу будут собраны обработки.
 
-## Дымовые тесты
-
-<a id="markdown-синтаксическая-проверка" name="#синтаксическая-проверка"></a>
-
-- <a href="https://github.com/vanessa-opensource/add/tree/develop/tests/smoke" target="_blank">Официальная документация по дымовым тестам</a>
-
-Если нужна авторизация в клиенте тестирования, добавьте в `xunit` ключ `--testclient`. Если версия `Vanessa-ADD` меньше `6.7.0`, замените плагины в библиотеке `C:\Program Files\OneScript\lib\add\plugins` на плагины из папки `plugins`.
-
-```json
-{
-  "xunit": {
-    "testsPath": "./tests",
-    "--xddConfig": "./tools/JSON/settingsSmoke.json",
-    "--reportsxunit": "ГенераторОтчетаAllureXMLВерсия2{allure/smoke/allure.xml}",
-    "--xddExitCodePath": "./build/xddExitCodePath.txt",
-    "--testclient": "Администратор:123456:1538"
-  }
-}
-```
-
-Если нужно подключаться к серверной базе, измените в `default` ключ `ibconnection`
-
-```json
-{
-  "default": {
-    "--ibconnection": "/Sservername\\basename"
-  }
-}
-```
-## Информация о поддержке метаданных
+<a id="markdown-описание-команд" name="#описание-команд"></a>
 
-С помощью <a href="https://github.com/vanessa-opensource/vanessa-support" target="_blank">vanessa-support</a> можно получить готовый json-файл для всех метаданных, которые могут быть изменены и не находятся в режиме чтения. Полученный файл можно использовать для групповой проверки доработок.
+## Описание команд
 
-```json
-{
- "Справочники": [
-  "ВидыНоменклатуры",
-  "Организации"
- ],
- "ПланыВидовХарактеристик": [
-  "СтатьиДоходов",
-  "СтатьиРасходов"
- ],
- "Документы": [
-  "АвансовыйОтчет",
-  "АктВыполненныхРабот"
- ],
- "Отчеты": [
-    "ABCXYZАнализНоменклатуры"
-   ]
-}
-```
-1) Укажите данные для подключения к ИБ в файле `env.json`
-2) Выполните команду `decompileCf.cmd`
-3) Выполните команду `getSupportObjects.cmd`
-4) Файл с результатом `tools\json\supportObjects.json`
+- `installVA.cmd` - обновление пакетов onescript, установка vanessa-runner, vanessa-add, vanessa-support
+- `runSyntax.cmd` - запуск синтаксической проверки
+- `runSmoke.cmd` - запуск дымовых тестов
+- `runAllure.cmd` - формирование отчета Allure. Предусмотрено сохранение истории
+- `runTests.cmd` - запуск трех команд: runSyntax, runSmoke, runAllure
+- `compileEpf.cmd` - cборка внешних обработок из исходников
+- `decompileEpf.cmd` - разборка внешних обработок на исходники
+- `decompileCf.cmd` - разборка конфигурации в исходники
+- `getSupportObjects.cmd` - получить json-файл для всех метаданных, которые могут быть изменены и не находятся в режиме чтения
+- `runGroupCheck.cmd` - запуск 1С:Предприятие с запуском обработки `ГрупповаяПроверкаДоработок.epf`
 
 ## Групповая проверка доработок
 
@@ -163,6 +113,63 @@
 
   <img src="https://raw.githubusercontent.com/leobrn/ones-smoke-allure/main/examples/group-check-allure2.png" alt="Allure" style="zoom:80%;" />
 
+## Дымовые тесты
+
+<a id="markdown-синтаксическая-проверка" name="#синтаксическая-проверка"></a>
+
+- <a href="https://github.com/vanessa-opensource/add/tree/develop/tests/smoke" target="_blank">Официальная документация по дымовым тестам</a>
+
+Если нужна авторизация в клиенте тестирования, добавьте в `xunit` ключ `--testclient`. Если версия `Vanessa-ADD` меньше `6.7.0`, замените плагины в библиотеке `C:\Program Files\OneScript\lib\add\plugins` на плагины из папки `plugins`.
+
+```json
+{
+  "xunit": {
+    "testsPath": "./tests",
+    "--xddConfig": "./tools/JSON/settingsSmoke.json",
+    "--reportsxunit": "ГенераторОтчетаAllureXMLВерсия2{allure/smoke/allure.xml}",
+    "--xddExitCodePath": "./build/xddExitCodePath.txt",
+    "--testclient": "Администратор:123456:1538"
+  }
+}
+```
+
+Если нужно подключаться к серверной базе, измените в `default` ключ `ibconnection`
+
+```json
+{
+  "default": {
+    "--ibconnection": "/Sservername\\basename"
+  }
+}
+```
+## Информация о поддержке метаданных
+
+С помощью <a href="https://github.com/vanessa-opensource/vanessa-support" target="_blank">vanessa-support</a> можно получить готовый json-файл для всех метаданных, которые могут быть изменены и не находятся в режиме чтения. Полученный файл можно использовать для групповой проверки доработок.
+
+```json
+{
+ "Справочники": [
+  "ВидыНоменклатуры",
+  "Организации"
+ ],
+ "ПланыВидовХарактеристик": [
+  "СтатьиДоходов",
+  "СтатьиРасходов"
+ ],
+ "Документы": [
+  "АвансовыйОтчет",
+  "АктВыполненныхРабот"
+ ],
+ "Отчеты": [
+    "ABCXYZАнализНоменклатуры"
+   ]
+}
+```
+1) Укажите данные для подключения к ИБ в файле `env.json`
+2) Выполните команду `decompileCf.cmd`
+3) Выполните команду `getSupportObjects.cmd`
+4) Файл с результатом `tools\json\supportObjects.json`
+
 ## Синтаксическая проверка
 
 Кроме дымовых тестов, включена синтаксическая проверка расширений.
@@ -191,21 +198,6 @@
     }
 ```
 
-<a id="markdown-описание-команд" name="#описание-команд"></a>
-
-## Описание команд
-
-- `installVA.cmd` - обновление пакетов onescript, установка vanessa-runner, vanessa-add, vanessa-support
-- `runSyntax.cmd` - запуск синтаксической проверки
-- `runSmoke.cmd` - запуск дымовых тестов
-- `runAllure.cmd` - формирование отчета Allure. Предусмотрено сохранение истории
-- `runTests.cmd` - запуск трех команд: runSyntax, runSmoke, runAllure
-- `compileEpf.cmd` - cборка внешних обработок из исходников
-- `decompileEpf.cmd` - разборка внешних обработок на исходники
-- `decompileCf.cmd` - разборка конфигурации в исходники
-- `getSupportObjects.cmd` - получить json-файл для всех метаданных, которые могут быть изменены и не находятся в режиме чтения
-- `runGroupCheck.cmd` - запуск 1С:Предприятие с запуском обработки `ГрупповаяПроверкаДоработок.epf`
-
 <a id="markdown-проверка-кода" name="#проверка-кода"></a>
 
 ## Проверка кода