Арина Кирпичева — Как начать документировать API
-
Upload
yandex -
Category
Technology
-
view
259 -
download
6
description
Transcript of Арина Кирпичева — Как начать документировать API
![Page 1: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/1.jpg)
1
![Page 2: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/2.jpg)
2
Как начать документировать API
Арина Кирпичёва разработчик технической документации
![Page 3: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/3.jpg)
3
Application Programming Interface
![Page 4: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/4.jpg)
4
Application Programming Interface
![Page 5: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/5.jpg)
5
Application Programming Interface
![Page 6: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/6.jpg)
6
Application Programming Interface КТО?
![Page 7: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/7.jpg)
7
![Page 8: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/8.jpg)
8
![Page 9: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/9.jpg)
9
Application Programming Interface КАК?
![Page 10: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/10.jpg)
10
Понятный API
?
Непонятный API
![Page 11: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/11.jpg)
11
Понятный API
Понять
Непонятный API
![Page 12: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/12.jpg)
12
Понятный API
Непонятный API
Докумен-тировать
![Page 13: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/13.jpg)
13
API для мобильных приложений
![Page 14: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/14.jpg)
14
Java
Objective-C
![Page 15: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/15.jpg)
15
1
![Page 16: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/16.jpg)
16
Oперационные системы
1
![Page 17: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/17.jpg)
17
![Page 18: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/18.jpg)
18
![Page 19: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/19.jpg)
19
![Page 20: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/20.jpg)
20
![Page 21: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/21.jpg)
21
2
![Page 22: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/22.jpg)
22
Технологии документиро-
вания
2
![Page 23: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/23.jpg)
23
Документация
Технологии документиро-
вания
Код
![Page 24: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/24.jpg)
24
Документация
Код
![Page 25: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/25.jpg)
25
Документация
Код
СИСТЕМЫ КОНТРОЛЯ ВЕРСИЙ
![Page 26: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/26.jpg)
26
Документация
Код
СИСТЕМЫ КОНТРОЛЯ ВЕРСИЙ
SVN
![Page 27: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/27.jpg)
27
Документация
Код
СИСТЕМЫ КОНТРОЛЯ ВЕРСИЙ
GIT SVN
![Page 28: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/28.jpg)
28
Документация
Код
СИСТЕМЫ КОНТРОЛЯ ВЕРСИЙ
GIT SVN
ПРИНЦИП ЕДИНОГО ИСТОЧНИКА
![Page 29: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/29.jpg)
29
Документация
Код
СИСТЕМЫ КОНТРОЛЯ ВЕРСИЙ
XML GIT
SVN
DITA ПРИНЦИП ЕДИНОГО ИСТОЧНИКА
![Page 30: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/30.jpg)
30
Документация
Код
![Page 31: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/31.jpg)
31
![Page 32: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/32.jpg)
32
![Page 33: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/33.jpg)
33
3
![Page 34: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/34.jpg)
34
API
3
![Page 35: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/35.jpg)
35
Integrated Development Environment
![Page 36: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/36.jpg)
36
Hello, world!
![Page 37: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/37.jpg)
37
![Page 38: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/38.jpg)
38
![Page 39: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/39.jpg)
39
![Page 40: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/40.jpg)
40
Быстрый старт
![Page 41: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/41.jpg)
41
Справочник
![Page 42: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/42.jpg)
42
developer.android.com developer.apple.com
![Page 43: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/43.jpg)
43
Формировать Поддерживать
![Page 44: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/44.jpg)
44
![Page 45: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/45.jpg)
45
4
![Page 46: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/46.jpg)
46
Генерация документации
из кода
4
![Page 47: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/47.jpg)
47
54 генератора 24 языка
![Page 48: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/48.jpg)
48
Java Objective-C
![Page 49: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/49.jpg)
49
Java Objective-C
JAVADOC ?
![Page 50: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/50.jpg)
50
Java Objective-C
JAVADOC ?
HEADERDOC ?
![Page 51: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/51.jpg)
51
Java Objective-C
JAVADOC
HEADERDOC
DOXYGEN
![Page 52: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/52.jpg)
52
Doxygen
Код+ комментарии
![Page 53: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/53.jpg)
53
Doxygen
Код+ комментарии
Параметры
![Page 54: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/54.jpg)
54
XML
Doxygen
Код+ комментарии
Параметры
![Page 55: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/55.jpg)
55
DITA XML
Программа
Doxygen XML
![Page 56: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/56.jpg)
56
Doxygen Программа
![Page 57: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/57.jpg)
57
Документация Справочник
Быстрый старт
Руководство разработчика
Примеры
![Page 58: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/58.jpg)
58
Оси Android iOS
![Page 59: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/59.jpg)
59
Оси
Системы контроля версий
Средства разработки
SVN GIT
Android iOS
Java Objective-C Intellij IDEA Android Studio Xcode
![Page 60: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/60.jpg)
60
Оси
Системы контроля версий
Средства разработки
Генераторы документации из кода
SVN GIT
Android iOS
Java Objective-C Intellij IDEA Android Studio Xcode
Doxygen
![Page 61: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/61.jpg)
61
![Page 62: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/62.jpg)
62
Оси
Системы контроля версий
Средства разработки
Генераторы документации из кода
SVN GIT
браузеры
JavaScript WebStorm
JSDoc
![Page 63: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/63.jpg)
63
Спасибо за внимание!
![Page 64: Арина Кирпичева — Как начать документировать API](https://reader034.fdocuments.net/reader034/viewer/2022042518/5594bf2f1a28ab99748b45c4/html5/thumbnails/64.jpg)
64
Арина Кирпичёва разработчик технической документации
Клуб техписателей clubs.ya.ru/x-plain