Tweet
Tweet

Slide 1

Slide 1 text

www.documentat.io Семëн Факторович sam@documentat.io Техническая документация в IT-проектах

Slide 2

Slide 2 text

Семён Факторович 15 лет в IT: 7 лет в разработке, 8 лет в документации Технический писатель → руководитель отдела документации → руководитель компании по разработке документации www.documentat.io

Slide 3

Slide 3 text

• О технической документации, которую мы пишем в процессе разработки софта • О ее целеполагании • О процессах ее создания и поддержки • Об инструментарии документирования • О роли технического писателя О чем этот курс?

Slide 4

Slide 4 text

• Всем кто хочет сделать свою документацию лучше • Тем, кто пишет документацию (не только техписателям) • Тем, кто управляет ее написанием или координирует его Кому адресован этот курс?

Slide 5

Slide 5 text

• Создание индустриальных практик управления документацией в IT-проектах • Создание культуры документирования • Популяризация профессии техписателя Зачем это мне?

Slide 6

Slide 6 text

• Два определения технической документации • Технический писатель: кто это и что он делает? • Какой набор документации необходим вашему проекту или продукту? О чем будем говорить сегодня

Slide 7

Slide 7 text

Документация — что это?

Slide 8

Slide 8 text

No content

Slide 9

Slide 9 text

No content

Slide 10

Slide 10 text

No content

Slide 11

Slide 11 text

No content

Slide 12

Slide 12 text

No content

Slide 13

Slide 13 text

No content

Slide 14

Slide 14 text

No content

Slide 15

Slide 15 text

• Руководства пользователя • Документация на API • Требования: техзадания, спецификации требований (SRS) • Описание архитектуры программных решений • Инструкции по развертыванию • README к опенсорсным продуктам Документация — что это?

Slide 16

Slide 16 text

Документация: определение №1

Slide 17

Slide 17 text

No content

Slide 18

Slide 18 text

• Внутри и снаружи проектной команды есть ее значимые участники — стейкхолдеры (stakeholders) • Между ними, как правило, есть каналы коммуникации Управление проектными коммуникациями

Slide 19

Slide 19 text

No content

Slide 20

Slide 20 text

No content

Slide 21

Slide 21 text

No content

Slide 22

Slide 22 text

No content

Slide 23

Slide 23 text

No content

Slide 24

Slide 24 text

No content

Slide 25

Slide 25 text

No content

Slide 26

Slide 26 text

No content

Slide 27

Slide 27 text

No content

Slide 28

Slide 28 text

• Интерактивные (realtime communications) • Неинтерактивные (push communications) • Пассивные, или «по запросу» (pull communications) Виды коммуникации

Slide 29

Slide 29 text

Телефонный разговор, чат, личная встреча… • Подразумевают быстрые вопросы и немедленные ответы • Не подразумевают «времени на обдумывание» • Подходят для решения срочных вопросов Интерактивные (realtime) коммуникации

Slide 30

Slide 30 text

Email, системы техподдержки… • Не подразумевают немедленного ответа • Дают возможность подумать над ответом • Подходят для несрочных вопросов Неинтерактивные (push) коммуникации

Slide 31

Slide 31 text

Базы знаний, wiki-системы, комплекты документации, индустриальные стандарты, онлайн-курсы, видеоинструкции… • Работают в режиме «вся информация уже выложена, читатель сам найдет ответ» • Самый медленный способ коммуникации Пассивные (pull) коммуникации

Slide 32

Slide 32 text

Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push

Slide 33

Slide 33 text

Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push

Slide 34

Slide 34 text

Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push

Slide 35

Slide 35 text

Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push

Slide 36

Slide 36 text

Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push

Slide 37

Slide 37 text

Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push

Slide 38

Slide 38 text

Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push

Slide 39

Slide 39 text

Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push

Slide 40

Slide 40 text

Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push

Slide 41

Slide 41 text

Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push

Slide 42

Slide 42 text

Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push

Slide 43

Slide 43 text

Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push

Slide 44

Slide 44 text

Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push

Slide 45

Slide 45 text

Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push

Slide 46

Slide 46 text

Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push

Slide 47

Slide 47 text

Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push

Slide 48

Slide 48 text

Техническая документация — пассивный (pull) способ реализации канала коммуникации между двумя четко определенными стейкхолдерами проекта.

Slide 49

Slide 49 text

Техническая документация — пассивный (pull) способ реализации канала коммуникации между двумя четко определенными стейкхолдерами проекта.

Slide 50

Slide 50 text

No content

Slide 51

Slide 51 text

Спецификация требований

Slide 52

Slide 52 text

Спецификация требований Техзадание

Slide 53

Slide 53 text

Спецификация требований Техзадание Техзадание

Slide 54

Slide 54 text

Спецификация требований Техзадание Техзадание Справочник API

Slide 55

Slide 55 text

Спецификация требований Техзадание Техзадание Справочник API Архитектура решения

Slide 56

Slide 56 text

Спецификация требований Техзадание Техзадание Справочник API Архитектура решения Руководство пользователя

Slide 57

Slide 57 text

Спецификация требований Техзадание Техзадание Справочник API Архитектура решения Руководство пользователя Troubleshooting guide

Slide 58

Slide 58 text

Техническая документация — пассивный (pull) способ реализации канала коммуникации между двумя четко определенными стейкхолдерами проекта.

Slide 59

Slide 59 text

Не каждый канал проектной коммуникации необходимо форсированно реализовывать (на офисной кухне тоже много каналов коммуникации, и что?)

Slide 60

Slide 60 text

Документация — не единственно возможный способ реализации коммуникаций

Slide 61

Slide 61 text

Спецификация требований Техзадание Техзадание Справочник API Архитектура решения Руководство пользователя Troubleshooting guide

Slide 62

Slide 62 text

Спецификация требований Техзадание Справочник API Архитектура решения Руководство пользователя Troubleshooting guide Устные обсуждения

Slide 63

Slide 63 text

Спецификация требований Техзадание Справочник API Руководство пользователя Troubleshooting guide Устный онбординг Устные обсуждения

Slide 64

Slide 64 text

Спецификация требований Устные обсуждения Техзадание Справочник API Устный онбординг Руководство пользователя Устные консультации

Slide 65

Slide 65 text

Документация возникает тогда, когда остальные способы реализации этого канала коммуникации слишком дороги.

Slide 66

Slide 66 text

• Pull-коммуникация — самая дорогая. Push и realtime, чаще всего, дешевле • Документация возникает в краевых случаях дороговизны push- и realtime-коммуникации для конкретной пары стейкхолдеров Парадокс документации как коммуникации

Slide 67

Slide 67 text

Когда pull лучше, чем push и realtime?

Slide 68

Slide 68 text

• Когда количество «получателей» коммуникации велико Когда pull лучше, чем push и realtime?

Slide 69

Slide 69 text

• Когда количество «получателей» коммуникации велико • Сотни тысяч пользователей Когда pull лучше, чем push и realtime?

Slide 70

Slide 70 text

• Когда количество «получателей» коммуникации велико • Сотни тысяч пользователей • Проектная команда из 40 разработчиков Когда pull лучше, чем push и realtime?

Slide 71

Slide 71 text

• Когда количество «получателей» коммуникации велико • Сотни тысяч пользователей • Проектная команда из 40 разработчиков Когда pull лучше, чем push и realtime?

Slide 72

Slide 72 text

• Когда количество «получателей» коммуникации велико • Сотни тысяч пользователей • Проектная команда из 40 разработчиков • Когда стоимость ошибки велика Когда pull лучше, чем push и realtime?

Slide 73

Slide 73 text

• Когда количество «получателей» коммуникации велико • Сотни тысяч пользователей • Проектная команда из 40 разработчиков • Когда стоимость ошибки велика • Ошибка в устной передаче требований приведет к дорогой переделке системы Когда pull лучше, чем push и realtime?

Slide 74

Slide 74 text

• Ее нужно сесть и написать • Ее нужно тестировать и профилировать — действительно ли она хорошо реализует этот канал коммуникации? • Ее нужно поддерживать в актуальном состоянии Документация требует инвестиций

Slide 75

Slide 75 text

Если документация неэффективно реализует канал коммуникации, ей не будут пользоваться. И перейдут к другим способам (realtime и push)

Slide 76

Slide 76 text

Еще одно определение технической документации

Slide 77

Slide 77 text

Не всякая pull-коммуникация — документация

Slide 78

Slide 78 text

Не всякая pull-коммуникация — документация EULA

Slide 79

Slide 79 text

Не всякая pull-коммуникация — документация EULA

Slide 80

Slide 80 text

Не всякая pull-коммуникация — документация EULA Продающие тексты на сайте

Slide 81

Slide 81 text

Не всякая pull-коммуникация — документация EULA Продающие тексты на сайте

Slide 82

Slide 82 text

Не всякая pull-коммуникация — документация EULA Продающие тексты на сайте Видеоинструкция

Slide 83

Slide 83 text

Техническая документация — это набор текстовых материалов, описывающих разные аспекты •создания, •внутреннего устройства •и эксплуатации программного продукта.

Slide 84

Slide 84 text

Техническая документация — это набор текстовых материалов, описывающих разные аспекты •создания, •внутреннего устройства •и эксплуатации программного продукта.

Slide 85

Slide 85 text

• Project visions • Техзадания и спецификации требований • Проектные планы • Roadmap-ы развития продукта • Бэклоги фич? • Планы на спринт? Создание продукта

Slide 86

Slide 86 text

• Архитектура программного решения • Описание инфраструктуры • Инструкции по развертыванию рабочего окружения Внутреннее устройство продукта

Slide 87

Slide 87 text

• Руководства пользователя и администратора • Справочники API • Инструкции по инсталляции • “How to contribute” Использование продукта

Slide 88

Slide 88 text

• Документация — способ реализации канала pull- коммуникации между проектными стейкхолдерами • Эта коммуникация освещает аспекты создания, использования или внутреннего устройства продукта • Этот способ реализации канала коммуникации дешевле, чем push или realtime • Этот канал коммуникации реализуется текстом и изображениями Подытожим определения

Slide 89

Slide 89 text

Минимально необходимый набор документации

Slide 90

Slide 90 text

Какие технические документы нужны в моем проекте?

Slide 91

Slide 91 text

PMBOK: Communication Plan Карта стейкхолдеров и каналов коммуникации между ними

Slide 92

Slide 92 text

ISO/IEC/IEEE 12207 Software life cycle processes Documentation Plan Карта стейкхолдеров и список документов, которые будут реализовывать каналы коммуникации между ними

Slide 93

Slide 93 text

Спецификация требований Техзадание Техзадание Справочник API Архитектура решения Руководство пользователя Troubleshooting guide

Slide 94

Slide 94 text

«Принимающих» стейкхолдеров может быть больше, чем вы ожидаете

Slide 95

Slide 95 text

«Принимающих» стейкхолдеров может быть больше, чем вы ожидаете Руководство пользователя Troubleshooting guide

Slide 96

Slide 96 text

«Принимающих» стейкхолдеров может быть больше, чем вы ожидаете

Slide 97

Slide 97 text

Адресаты документации на API

Slide 98

Slide 98 text

• Я знаком с этим API, мне нужно посмотреть сигнатуру конкретного метода Адресаты документации на API

Slide 99

Slide 99 text

• Я знаком с этим API, мне нужно посмотреть сигнатуру конкретного метода • Я не знаком с этим API, мне нужно почитать примеры использования и пройти пару уроков Адресаты документации на API

Slide 100

Slide 100 text

• Я знаком с этим API, мне нужно посмотреть сигнатуру конкретного метода • Я не знаком с этим API, мне нужно почитать примеры использования и пройти пару уроков • Я знаком с конкурирующими API, мне нужно быстро понять, чем вы лучше Адресаты документации на API

Slide 101

Slide 101 text

Адресаты документации на API

Slide 102

Slide 102 text

Адресаты документации на API Справочник API API guides & tutorials Обзор возможностей API

Slide 103

Slide 103 text

Адресаты документации на API Справочник API API guides & tutorials Обзор возможностей API

Slide 104

Slide 104 text

• Обзор возможностей и целеполагание • Вводные уроки и поясняющие статьи • Справочник методов Документация на API — это не только Swagger

Slide 105

Slide 105 text

• Обзор возможностей и целеполагание • Вводные уроки и поясняющие статьи • Справочник методов Документация на API — это не только Swagger www.documentat.io

Slide 106

Slide 106 text

Как сделать так, чтобы документация появилась?

Slide 107

Slide 107 text

• Нарисуйте карту стейкходлеров Как сделать так, чтобы документация появилась?

Slide 108

Slide 108 text

• Нарисуйте карту стейкходлеров • Определите, какие каналы стоит реализовать в виде документации Как сделать так, чтобы документация появилась?

Slide 109

Slide 109 text

• Нарисуйте карту стейкходлеров • Определите, какие каналы стоит реализовать в виде документации • Напишите документацию для каждого из каналов Как сделать так, чтобы документация появилась?

Slide 110

Slide 110 text

Канал коммуникации = документ?

Slide 111

Slide 111 text

• Кто оба стейкхолдера (говорящий и принимающий?) Канал коммуникации = документ?

Slide 112

Slide 112 text

• Кто оба стейкхолдера (говорящий и принимающий?) • Зачем вообще реализовывать этот канал коммуникации? Зачем он проекту? А бизнесу? Канал коммуникации = документ?

Slide 113

Slide 113 text

• Кто оба стейкхолдера (говорящий и принимающий?) • Зачем вообще реализовывать этот канал коммуникации? Зачем он проекту? А бизнесу? • Точно ли документация — самый дешевый способ реализации этого канала? Канал коммуникации = документ?

Slide 114

Slide 114 text

Реализация канала коммуникации

Slide 115

Slide 115 text

• Каков контекст принимающего стейкхолдера? Что он знает и чего он не знает? Реализация канала коммуникации

Slide 116

Slide 116 text

• Каков контекст принимающего стейкхолдера? Что он знает и чего он не знает? • Что именно хочет сообщить «говорящий» стейкхолдер? Какие еще есть источники информации? Реализация канала коммуникации

Slide 117

Slide 117 text

• Каков контекст принимающего стейкхолдера? Что он знает и чего он не знает? • Что именно хочет сообщить «говорящий» стейкхолдер? Какие еще есть источники информации? • Как это правильно структурировать, написать и оформить? Реализация канала коммуникации

Slide 118

Slide 118 text

Технический писатель как имплементатор канала коммуникации

Slide 119

Slide 119 text

• Понять нужды стейкхолдеров Технический писатель как имплементатор канала коммуникации

Slide 120

Slide 120 text

• Понять нужды стейкхолдеров • Собрать, изучить и структурировать информацию Технический писатель как имплементатор канала коммуникации

Slide 121

Slide 121 text

• Понять нужды стейкхолдеров • Собрать, изучить и структурировать информацию • Спроектировать ее текстовое представление (чтобы канал коммуникации был реализован эффективно) Технический писатель как имплементатор канала коммуникации

Slide 122

Slide 122 text

• Понять нужды стейкхолдеров • Собрать, изучить и структурировать информацию • Спроектировать ее текстовое представление (чтобы канал коммуникации был реализован эффективно) • Написать понятный и грамотный текст Технический писатель как имплементатор канала коммуникации

Slide 123

Slide 123 text

• Понять нужды стейкхолдеров • Собрать, изучить и структурировать информацию • Спроектировать ее текстовое представление (чтобы канал коммуникации был реализован эффективно) • Написать понятный и грамотный текст Технический писатель как имплементатор канала коммуникации Это сложный и небанальный набор навыков. Они есть не у всех.

Slide 124

Slide 124 text

• Понять нужды стейкхолдеров • Собрать, изучить и структурировать информацию • Спроектировать ее текстовое представление (чтобы канал коммуникации был реализован эффективно) • Написать понятный и грамотный текст Технический писатель как имплементатор канала коммуникации www.documentat.io

Slide 125

Slide 125 text

• Нарисуйте карту стейкходлеров • Определите, какие каналы стоит реализовать в виде документации • Напишите документацию для каждого из каналов Как понять, какая документация нужна вашему продукту/проекту?

Slide 126

Slide 126 text

• Нарисуйте карту стейкхолдеров • Определите, какие каналы стоит реализовать в виде документации • Напишите документацию для каждого из каналов Как понять, какая документация нужна вашему продукту/проекту? Или позовите техписателя

Slide 127

Slide 127 text

• Техзадание, высокоуровневые бизнес-требования • SRS, функциональные и нефункциональные требования • Инструкция по развертыванию рабочего окружения • Инструкция по развертыванию продукта • Руководство пользователя • Документация на API • Архитектура решения • Онбординг новому сотруднику Чеклист документации для IT-продукта Документ Кому он адресован Техзадание (высокоуровневые бизнес- требования) Бизнесовые стейкхолдеры SRS, спецификация требований (функциональных и нефункциональных) Команда разработки Инструкция по настройке рабочего окружения Программисты Инструкция по установке/развертыванию Интеграторы клиента Руководство пользователя Конечные пользователи Документация на API: справочник, вводные/обучающие статьи Программисты (внешние и внутренние) Архитектурного программного решения: структура компонентов, модулей, классов… Программисты Документ «первого дня» для нового сотрудника: о чем проект, ссылки на основные ресурсы, ссылки на документацию… Программисты

Slide 128

Slide 128 text

• Техзадание, высокоуровневые бизнес-требования • SRS, функциональные и нефункциональные требования • Инструкция по развертыванию рабочего окружения • Инструкция по развертыванию продукта • Руководство пользователя • Документация на API • Архитектура решения • Онбординг новому сотруднику Чеклист документации для IT-продукта Документ Кому он адресован Зачем он Техзадание (высокоуровневые бизнес- требования) Бизнесовые стейкхолдеры SRS, спецификация требований (функциональных и нефункциональных) Команда разработки Инструкция по настройке рабочего окружения Программисты Инструкция по установке/развертыванию Интеграторы клиента Руководство пользователя Конечные пользователи Документация на API: справочник, вводные/обучающие статьи Программисты (внешние и внутренние) Архитектурного программного решения: структура компонентов, модулей, классов… Программисты Документ «первого дня» для нового сотрудника: о чем проект, ссылки на основные ресурсы, ссылки на документацию… Программисты

Slide 129

Slide 129 text

• Техзадание, высокоуровневые бизнес-требования • SRS, функциональные и нефункциональные требования • Инструкция по развертыванию рабочего окружения • Инструкция по развертыванию продукта • Руководство пользователя • Документация на API • Архитектура решения • Онбординг новому сотруднику Чеклист документации для IT-продукта Документ Кому он адресован Зачем он Техзадание (высокоуровневые бизнес- требования) Бизнесовые стейкхолдеры Снижение риска «сделать не то» SRS, спецификация требований (функциональных и нефункциональных) Команда разработки Инструкция по настройке рабочего окружения Программисты Инструкция по установке/развертыванию Интеграторы клиента Руководство пользователя Конечные пользователи Документация на API: справочник, вводные/обучающие статьи Программисты (внешние и внутренние) Архитектурного программного решения: структура компонентов, модулей, классов… Программисты Документ «первого дня» для нового сотрудника: о чем проект, ссылки на основные ресурсы, ссылки на документацию… Программисты

Slide 130

Slide 130 text

• Техзадание, высокоуровневые бизнес-требования • SRS, функциональные и нефункциональные требования • Инструкция по развертыванию рабочего окружения • Инструкция по развертыванию продукта • Руководство пользователя • Документация на API • Архитектура решения • Онбординг новому сотруднику Чеклист документации для IT-продукта Документ Кому он адресован Зачем он Техзадание (высокоуровневые бизнес- требования) Бизнесовые стейкхолдеры Снижение риска «сделать не то» SRS, спецификация требований (функциональных и нефункциональных) Команда разработки Снижение риска «сделать не то» Инструкция по настройке рабочего окружения Программисты Инструкция по установке/развертыванию Интеграторы клиента Руководство пользователя Конечные пользователи Документация на API: справочник, вводные/обучающие статьи Программисты (внешние и внутренние) Архитектурного программного решения: структура компонентов, модулей, классов… Программисты Документ «первого дня» для нового сотрудника: о чем проект, ссылки на основные ресурсы, ссылки на документацию… Программисты

Slide 131

Slide 131 text

• Техзадание, высокоуровневые бизнес-требования • SRS, функциональные и нефункциональные требования • Инструкция по развертыванию рабочего окружения • Инструкция по развертыванию продукта • Руководство пользователя • Документация на API • Архитектура решения • Онбординг новому сотруднику Чеклист документации для IT-продукта Документ Кому он адресован Зачем он Техзадание (высокоуровневые бизнес- требования) Бизнесовые стейкхолдеры Снижение риска «сделать не то» SRS, спецификация требований (функциональных и нефункциональных) Команда разработки Снижение риска «сделать не то» Инструкция по настройке рабочего окружения Программисты Ускорение онбординга Инструкция по установке/развертыванию Интеграторы клиента Руководство пользователя Конечные пользователи Документация на API: справочник, вводные/обучающие статьи Программисты (внешние и внутренние) Архитектурного программного решения: структура компонентов, модулей, классов… Программисты Документ «первого дня» для нового сотрудника: о чем проект, ссылки на основные ресурсы, ссылки на документацию… Программисты

Slide 132

Slide 132 text

• Техзадание, высокоуровневые бизнес-требования • SRS, функциональные и нефункциональные требования • Инструкция по развертыванию рабочего окружения • Инструкция по развертыванию продукта • Руководство пользователя • Документация на API • Архитектура решения • Онбординг новому сотруднику Чеклист документации для IT-продукта Документ Кому он адресован Зачем он Техзадание (высокоуровневые бизнес- требования) Бизнесовые стейкхолдеры Снижение риска «сделать не то» SRS, спецификация требований (функциональных и нефункциональных) Команда разработки Снижение риска «сделать не то» Инструкция по настройке рабочего окружения Программисты Ускорение онбординга Инструкция по установке/развертыванию Интеграторы клиента Снижение нагрузки на техподдержку Руководство пользователя Конечные пользователи Документация на API: справочник, вводные/обучающие статьи Программисты (внешние и внутренние) Архитектурного программного решения: структура компонентов, модулей, классов… Программисты Документ «первого дня» для нового сотрудника: о чем проект, ссылки на основные ресурсы, ссылки на документацию… Программисты

Slide 133

Slide 133 text

• Техзадание, высокоуровневые бизнес-требования • SRS, функциональные и нефункциональные требования • Инструкция по развертыванию рабочего окружения • Инструкция по развертыванию продукта • Руководство пользователя • Документация на API • Архитектура решения • Онбординг новому сотруднику Чеклист документации для IT-продукта Документ Кому он адресован Зачем он Техзадание (высокоуровневые бизнес- требования) Бизнесовые стейкхолдеры Снижение риска «сделать не то» SRS, спецификация требований (функциональных и нефункциональных) Команда разработки Снижение риска «сделать не то» Инструкция по настройке рабочего окружения Программисты Ускорение онбординга Инструкция по установке/развертыванию Интеграторы клиента Снижение нагрузки на техподдержку Руководство пользователя Конечные пользователи Снижение нагрузки на техподдержку Документация на API: справочник, вводные/обучающие статьи Программисты (внешние и внутренние) Архитектурного программного решения: структура компонентов, модулей, классов… Программисты Документ «первого дня» для нового сотрудника: о чем проект, ссылки на основные ресурсы, ссылки на документацию… Программисты

Slide 134

Slide 134 text

• Техзадание, высокоуровневые бизнес-требования • SRS, функциональные и нефункциональные требования • Инструкция по развертыванию рабочего окружения • Инструкция по развертыванию продукта • Руководство пользователя • Документация на API • Архитектура решения • Онбординг новому сотруднику Чеклист документации для IT-продукта Документ Кому он адресован Зачем он Техзадание (высокоуровневые бизнес- требования) Бизнесовые стейкхолдеры Снижение риска «сделать не то» SRS, спецификация требований (функциональных и нефункциональных) Команда разработки Снижение риска «сделать не то» Инструкция по настройке рабочего окружения Программисты Ускорение онбординга Инструкция по установке/развертыванию Интеграторы клиента Снижение нагрузки на техподдержку Руководство пользователя Конечные пользователи Снижение нагрузки на техподдержку Документация на API: справочник, вводные/обучающие статьи Программисты (внешние и внутренние) Снижение нагрузки на команду разработки Архитектурного программного решения: структура компонентов, модулей, классов… Программисты Документ «первого дня» для нового сотрудника: о чем проект, ссылки на основные ресурсы, ссылки на документацию… Программисты

Slide 135

Slide 135 text

• Техзадание, высокоуровневые бизнес-требования • SRS, функциональные и нефункциональные требования • Инструкция по развертыванию рабочего окружения • Инструкция по развертыванию продукта • Руководство пользователя • Документация на API • Архитектура решения • Онбординг новому сотруднику Чеклист документации для IT-продукта Документ Кому он адресован Зачем он Техзадание (высокоуровневые бизнес- требования) Бизнесовые стейкхолдеры Снижение риска «сделать не то» SRS, спецификация требований (функциональных и нефункциональных) Команда разработки Снижение риска «сделать не то» Инструкция по настройке рабочего окружения Программисты Ускорение онбординга Инструкция по установке/развертыванию Интеграторы клиента Снижение нагрузки на техподдержку Руководство пользователя Конечные пользователи Снижение нагрузки на техподдержку Документация на API: справочник, вводные/обучающие статьи Программисты (внешние и внутренние) Снижение нагрузки на команду разработки Архитектурного программного решения: структура компонентов, модулей, классов… Программисты Ускорение онбординга Документ «первого дня» для нового сотрудника: о чем проект, ссылки на основные ресурсы, ссылки на документацию… Программисты

Slide 136

Slide 136 text

• Техзадание, высокоуровневые бизнес-требования • SRS, функциональные и нефункциональные требования • Инструкция по развертыванию рабочего окружения • Инструкция по развертыванию продукта • Руководство пользователя • Документация на API • Архитектура решения • Онбординг новому сотруднику Чеклист документации для IT-продукта Документ Кому он адресован Зачем он Техзадание (высокоуровневые бизнес- требования) Бизнесовые стейкхолдеры Снижение риска «сделать не то» SRS, спецификация требований (функциональных и нефункциональных) Команда разработки Снижение риска «сделать не то» Инструкция по настройке рабочего окружения Программисты Ускорение онбординга Инструкция по установке/развертыванию Интеграторы клиента Снижение нагрузки на техподдержку Руководство пользователя Конечные пользователи Снижение нагрузки на техподдержку Документация на API: справочник, вводные/обучающие статьи Программисты (внешние и внутренние) Снижение нагрузки на команду разработки Архитектурного программного решения: структура компонентов, модулей, классов… Программисты Ускорение онбординга Документ «первого дня» для нового сотрудника: о чем проект, ссылки на основные ресурсы, ссылки на документацию… Программисты Ускорение онбординга

Slide 137

Slide 137 text

Документация — это про деньги. Эффективно реализованный канал коммуникации экономит трудозатраты и снижает риски.

Slide 138

Slide 138 text

• Документация — способ реализации канала коммуникации между стейкхолдерами • Не каждый канал должен быть реализован документацией • Техписатель — имплементатор этого канала • Документация — это про деньги Подытожим

Slide 139

Slide 139 text

• Документация не радует: почему так получилось и что делать • Документация: процесс или артефакт? Да! • Типовые процессы вокруг документации В следующей серии

Slide 140

Slide 140 text

• Заказная разработка документации • Консалтинг и настройка процессов • Бесплатный аудит вашей документации Обязательная минутка рекламы www.documentat.io