2. Сергей Черкасов
Разработчик
Документация
Wiki
Задачи

3. Документирование
информации

4. 4 Погода

5. 5
Зачем нужна документация
1. Сохранение информации
2. Передача информации
3. Помогает лучше формулировать и
структурировать информацию
4. Экономит время

6. 6
Что важно
1. Аудитория
2. Сформулировать цель документа
3. Язык должен быть понятен аудитории
4. Доступность
5. Актуальность

7. Примеры

8. 8
Документация как продукт и часть
продукта
1. Описание API
2. Help
3. User guide

9. 9
В процессе разработки
1. Описание кода, API
2. Style guide
3. Статьи, how-to
4. Отчёты
5. Требования
6. Результаты и агенда встреч
7. ...

10. 10
Комментарии в коде —
документация или нет?

11. 11
Самодокументируемый код
— миф или реальность?

12. 12
Кто пишет документацию
1. Технические писатели
2. Разработчики
3. Менеджеры
4. Тестировщики
5. Аналитики
6. Все

13. 13
Писать или не писать?

14. 14
Выбор: библиотека похуже с
документацией или
получше, но без
документации?

15. 15
Инструменты
1. Специальные программы
2. Wiki
3. Генераторы из кода — JSDoc, Sphinx
4. Latex
5. MS Office
6. MindMaps
7. Issue-трекеры
8. ...

16. Вопросы?

17. Wiki-синтаксис

18. 18
Особенности wiki
1. Совместное редактирование
2. Разметка и структурирование текста
3. Много разных wiki-инструементов
4. Права доступа на отдельный документ
5. Уведомление про изменения отдельного
документа

19. 19
Для чего нужно форматирование
1. Разные отображения (view) и стили
2. Автогенерация
3. Проще редактировать

20. 20
Форматирование текста
1. Вид текста
2. Списки
3. Таблицы

21. 21
Структурирование документа
1. Заголовки
2. Оглавление
3. Сноски

22. 22
Встраиваемые элементы
1. Форматированный код
2. Динамическин блоки
3. Графики, диаграммы (Graphviz)
4. Формы

23. 23
Интеграция с другими сервисами
1. Трекеры задач
2. Стафф
3. Календари, планировщики

24. 24
Как узнать о wiki-
синтаксисе?

25. 25
Посмотреть в документации.

26. Вопросы?

27. Задачи и работа с
ними.

28. 28
Кому нужны задачи и системы работы
с ними?
1. Разработчику
2. Команде
3. Менеджерам
4. Заинтересованным людям (стейкхолдерам)

29. 29
Зачем нужны задачи и системы для
работы с ними?
1. Внешняя память
2. Структурирование
3. Фокусировка
4. Планирование
5. Автоматизация
6. Накопление истории

30. 30
Workflow
1. Зависит от команды и типа задачи
2. В основном: new (open) → in progress →
ready → closed
3. Может меняться со временем — это
просто инструмент

31. 31
Что такое хорошо
сформулированная задача?

32. 32
Зачем нужны системы управления
задачами?
1. Удобней взаимодействовать
2. Автоматизация
3. Поиск
4. Разные view (дашборды)

33. Вопросы?

34. Сергей Черкасов
Разработчик
Спасибо
tapot@yandex-team.ru