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