Какой способ структурирования потоков лучше для технического README.md? - PullRequest
0 голосов
/ 23 апреля 2019

Мы пишем документ, и обсуждаются два предложения, мы не можем принять решение, какое из них лучше, вот они:

Предложение № 1:

Класс ABC предоставляет интерфейс для машинной информации, которая должна быть передана в SDK.Информация о машине должна быть снабжена уникальным идентификатором машины, который не является идентификационным номером машины (MIN).Эта информация необходима для прохождения процесса сертификации.

В следующем примере JSON перечислены все сведения, которые можно использовать для улучшения работы ИИ на компьютере.

{
  "abc.machine":
  {
     "info": {
         "make": "<MAKE>",
         "model": "<MODEL>",
         "year": "<YEAR>",
         "machineIdentifier": "<MACHINE_IDENTIFIER>"
     }
  }
}

Прочтите подробную информацию о классе конфигурации машины в справочной документации API.

Предложение № 2:

Класс ABC предоставляет интерфейс для информации о машине, которая должна бытьпоставляется в SDK.

В следующем примере JSON перечисляется вся информация, которая может использоваться для улучшения работы ИИ в машине.

{
  "abc.machine":
  {
     "info": {
         "make": "<MAKE>",
         "model": "<MODEL>",
         "year": "<YEAR>",
         "machineIdentifier": "<MACHINE_IDENTIFIER>"
     }
  }
}

Информация о машине должна быть предоставлена ​​суникальный идентификатор машины, который не является идентификационным номером машины (MIN).Эта информация необходима для прохождения процесса сертификации.

Прочитайте подробную информацию о классе конфигурации машины в справочной документации API.

Они - ключ, где мы должны оставить это:

Информация о машине должна быть снабжена уникальным идентификатором машины, который не является идентификационным номером машины (MIN).Эта информация необходима для прохождения процесса сертификации.

в документе: либо до примера JSON, либо после.

Мысли / замечания по этому вопросу приветствуются!

...