documentation

Свойство schema.org ^?

Этот термин находится в "новой" области — обратная связь по реализации и использование в приложениях и на веб-сайтах могут помочь улучшить определения.

Thing > Property :: documentation

Канонический URL: https://schema.org/documentation
👉 Проверить на наличие открытых проблем.

Содержание: Описание, Какие должны быть типы, В каких типах используется, Ссылка на источник термина, Примеры использования.

Описание:

Дальнейшая документация, описывающая Web API более подробно.

Свойство "documentation" в Schema.org используется для указания дополнительной информации или документации, связанной с определённым объектом или ресурсом. Это свойство может применяться в различных контекстах, например, в отношении программного обеспечения, веб-API, библиотек или других технологий.

Основная цель свойства "documentation" — предоставить пользователям и разработчикам доступ к более подробным инструкциям, спецификациям или описаниям, которые могут помочь в использовании или интеграции данного ресурса. Это может включать ссылки на официальные руководства, описания функций, примеры использования и другую полезную информацию.

Использование свойства "documentation" важно для улучшения взаимодействия между пользователями и ресурсами, так как оно облегчает поиск необходимой информации и понимание того, как эффективно использовать данный объект. В контексте веб-разработки и технологий это способствует более быстрому и простому внедрению и использованию различных инструментов и API, что, в свою очередь, может улучшить общую производительность и опыт пользователей.

Таким образом, свойство "documentation" является важным элементом в Schema.org, который помогает структурировать и стандартизировать информацию, делая её более доступной и понятной для всех заинтересованных сторон.

Ожидается, что значения будут одного из этих типов

Используется в этих типах

WebAPI ^?

Источник

https://github.com/schemaorg/schemaorg/issues/1423

Примеры

Пример 1

Пример заметки или HTML разметки.


See JSON example.

Пример, закодированный в формате JSON-LD в теге <script> HTML.


<script type="application/ld+json">
{
  "@context": "https://schema.org/",
  "@type": "WebAPI",
  "name": "Google Knowledge Graph Search API",
  "description": "The Knowledge Graph Search API lets you find entities in the Google Knowledge Graph. The API uses standard schema.org types and is compliant with the JSON-LD specification.",
  "documentation": "https://developers.google.com/knowledge-graph/",
  "termsOfService": "https://developers.google.com/knowledge-graph/terms",
  "provider": {
    "@type": "Organization",
    "name": "Google Inc."
  }
}
</script>

Структурированное представление примера JSON-LD.

@context

https://schema.org/

@type

WebAPI

name

Google Knowledge Graph Search API

description

The Knowledge Graph Search API lets you find entities in the Google Knowledge Graph. The API uses standard schema.org types and is compliant with the JSON-LD specification.

documentation

https://developers.google.com/knowledge-graph/

termsOfService

https://developers.google.com/knowledge-graph/terms

provider

@type: Organization
name: Google Inc.

Автор: Семён Авдосов [schema.su]

Дата публикации: 16.11.2024

Дата обновления: 20.11.2024

Комментарии