AI Lab

Open Artificial Intelligence Laboratory

Состав offline документации проекта RDK и рекомендации по ознакомлению

Скачать: RDK.DocumentsList.Ru.doc

На рисунке ниже представлено условное разбиение всех документов на две группы – для пользователя и разработчика. Зеленым отмечены готовые документы. Желтым – документы, содержащие актуальные сведения, но неоконченные.

RDK.DocumentsList.Ru pic1

 

Перечень документов:

  1. Назначение библиотеки: RDK.Purposes.Ru.doc
  2. Руководство пользователя: RDK.UsersGuide.Ru.doc
  3. Структура файлов библиотеки: RDK.FileStructure.Ru.doc
  4. Соглашения (об именованиях, и т.п.): RDK. Conventions.Ru.doc
  5. Руководство разработчика: RDK.DevelopersGuide.Ru.doc
  6. Быстрый старт. Использование в проекте. RDK.QuickStart.UsingToProject.Ru.doc
  7. Быстрый старт. Разработка конечного компонента. RDK.QuickStart.ComponentDevelopment.Ru.doc
  8. Быстрый старт. Разработка группы компонент. RDK.QuickStart.ComponentGroupDevelopment.Ru.doc
  9. Быстрый старт. Разработка библиотеки компонент. RDK.QuickStart.ComponentLibraryDevelopment.Ru.doc
  10. Быстрый старт. Разработка новой SDK на базе RDK. RDK.QuickStart.DerivedSDKDevelopment.Ru.doc
  11. Описание стандартных компонент. Руководство пользователя. RDK.StandardComponentDescription.UsersGuide.Ru.doc
  12. Описание примеров. RDK.SamplesDescription.Ru.doc
  13. Описание проектов, формирующих бинарные файлы библиотеки: RDK.BuildProjectsDescription.UsersGuide.Ru.doc

 

3 Сценарии изучения документации

Ниже предложены различные варианты ознакомления с документацией, в зависимости от целей, стоящих перед разработчиком.

1 Пользователь готовой библиотеки (разработчик конечного ПО)

  1. Назначение библиотеки: RDK.Purposes.Ru.doc
  2. Быстрый старт. Использование в проекте. RDK.QuickStart.UsingToProject.Ru.doc
  3. Описание стандартных компонент. Руководство пользователя. RDK.StandardComponentDescription.UsersGuide.Ru.doc
  4. Описание примеров. RDK.SamplesDescription.Ru.doc
  5. Описание проектов, формирующих бинарные файлы библиотеки: RDK.BuildProjectsDescription.UsersGuide.Ru.doc
  6. Руководство пользователя: RDK.UsersGuide.Ru.doc
  7. Назначение библиотеки: RDK.Purposes.Ru.doc
  8. Быстрый старт. Разработка конечного компонента. RDK.QuickStart.ComponentDevelopment.Ru.doc
  9. Быстрый старт. Разработка группы компонент. RDK.QuickStart.ComponentGroupDevelopment.Ru.doc
  10. Быстрый старт. Разработка библиотеки компонент. RDK.QuickStart.ComponentLibraryDevelopment.Ru.doc
  11. Соглашения (об именованиях, и т.п.): RDK. Conventions.Ru.doc
  12. Структура файлов библиотеки: RDK.FileStructure.Ru.doc
  13. Руководство разработчика: RDK.DevelopersGuide.Ru.doc
  14. Описание стандартных компонент. Руководство пользователя. RDK.StandardComponentDescription.UsersGuide.Ru.doc
  15. Описание примеров. RDK.SamplesDescription.Ru.doc

2 Разработчик компонент, реализующих конкретные алгоритмы библиотеки

  1. Назначение библиотеки: RDK.Purposes.Ru.doc
  2. Быстрый старт. Разработка конечного компонента. RDK.QuickStart.ComponentDevelopment.Ru.doc
  3. Быстрый старт. Разработка группы компонент. RDK.QuickStart.ComponentGroupDevelopment.Ru.doc
  4. Быстрый старт. Разработка библиотеки компонент. RDK.QuickStart.ComponentLibraryDevelopment.Ru.doc
  5. Соглашения (об именованиях, и т.п.): RDK. Conventions.Ru.doc
  6. Структура файлов библиотеки: RDK.FileStructure.Ru.doc
  7. Руководство разработчика: RDK.DevelopersGuide.Ru.doc
  8. Описание стандартных компонент. Руководство пользователя. RDK.StandardComponentDescription.UsersGuide.Ru.doc
  9. Описание примеров. RDK.SamplesDescription.Ru.doc

Последние два документа рекомендуются к изучению как прототип для написания документации на разрабатываемые компоненты.

3 Разработчик SDK производной от RDK

  1. Назначение библиотеки: RDK.Purposes.Ru.doc
  2. Структура файлов библиотеки: RDK.FileStructure.Ru.doc
  3. Соглашения (об именованиях, и т.п.): RDK. Conventions.Ru.doc
  4. Быстрый старт. Разработка новой SDK на базе RDK. RDK.QuickStart.DerivedSDKDevelopment.Ru.doc
  5. Быстрый старт. Использование в проекте. RDK.QuickStart.UsingToProject.Ru.doc
  6. Описание проектов, формирующих бинарные файлы библиотеки: RDK.BuildProjectsDescription.UsersGuide.Ru.doc

4 Разработчик стороннего ПО, использующий классы RDK в явном виде

  1. Назначение библиотеки: RDK.Purposes.Ru.doc
  2. Структура файлов библиотеки: RDK.FileStructure.Ru.doc
  3. Соглашения (об именованиях, и т.п.): RDK. Conventions.Ru.doc
  4. Руководство разработчика: RDK.DevelopersGuide.Ru.doc
  5. Руководство пользователя: RDK.UsersGuide.Ru.doc
  6. Описание стандартных компонент. Руководство пользователя. RDK.StandardComponentDescription.UsersGuide.Ru.doc

 

 

Обсудить на форуме (комментариев 0).
Разработки RDK Состав offline документации проекта RDK и рекомендации по ознакомлению