Ведение продуктового учета#

Продуктовый учет - это набор продуктов и их компонентов, для которых готовится документация. Каждый продукт может быть самостоятельным или включать в себя компоненты.

Сайт с документацией формируется автоматически на основе данных из продуктового учета по модели: Категория > Продукты > Компоненты.

Продуктовый учет располагается в папке product-registry/.

Важно

Для корректной работы GetDocs с продуктовым учетом необходимо, чтобы продукты имели трехбуквенные коды-идентификаторы (поле code).

Категории в учете ведутся в файле categories.json:

{
  "entities": [
    {
      "id": "Идентификатор категории.",
      "name": "Имя категории.",
      "description": "Описание продукта.",
    }
  ]
}

Продукты в учете регистрируются по кодам и ведутся в файле products.json:

{
  "entities": [
    {
      "id": "Идентификатор продукта",
      "code": "XYZ",
      "name": "Имя продукта.",
      "longDescription": "Длинное описание продукта.",
      "shortDescription": "Краткое описание продукта.",
      "category": {
        "id": "Идентификатор категории (должен быть одним из идентификаторов в categories.json)",
        "name": "Имя категории, в которую входит продукт.",
        "description": "Описание категории, в которую входит продукт."
      },
      "type": {
        "name": "Зарезервировано для будущего использования."
      }
    }
  ]
}

Компоненты в учете регистрируются по кодам и ведутся в файле components.json:

{
  "entities": [
    {
      "id": "Идентификатор компонента",
      "code": "XYZA",
      "productCode": "Имя продукта, в который входит компонент",
      "name": "Имя компонента.",
      "shortDescription": "Краткое описание компонента.",
      "type": {
        "name": "Зарезервировано для будущего использования."
      }
    }
  ]
}