(#1) Техническая документация в IT-проектах. Определение технической документации.

http://documentat.io/sdo

http://documentat.io/sdo/courses/open-course

Открытый онлайн-курс о технической документации в IT-проектах.

Чат для обсуждений: https://t.me/TechDocIT

Лекция 1. Два определения технической документации. Какая документация необходима в вашем проекте? Кто такой техписатель и зачем он вам нужен.

Видео: https://youtu.be/w0DNTDE3EgE

Transcript

1. www.documentat.io Семëн Факторович sam@documentat.io Техническая документация в IT-проектах
2. Семён Факторович 15 лет в IT: 7 лет в разработке, 8 лет в документации Технический писатель → руководитель отдела документации → руководитель компании по разработке документации www.documentat.io
3. • О технической документации, которую мы пишем в процессе разработки софта • О ее целеполагании • О процессах ее создания и поддержки • Об инструментарии документирования • О роли технического писателя О чем этот курс?
4. • Всем кто хочет сделать свою документацию лучше • Тем, кто пишет документацию (не только техписателям) • Тем, кто управляет ее написанием или координирует его Кому адресован этот курс?
5. • Создание индустриальных практик управления документацией в IT-проектах • Создание культуры документирования • Популяризация профессии техписателя Зачем это мне?
6. • Два определения технической документации • Технический писатель: кто это и что он делает? • Какой набор документации необходим вашему проекту или продукту? О чем будем говорить сегодня
7. Документация — что это?
15. • Руководства пользователя • Документация на API • Требования: техзадания, спецификации требований (SRS) • Описание архитектуры программных решений • Инструкции по развертыванию • README к опенсорсным продуктам Документация — что это?
16. Документация: определение №1
18. • Внутри и снаружи проектной команды есть ее значимые участники — стейкхолдеры (stakeholders) • Между ними, как правило, есть каналы коммуникации Управление проектными коммуникациями
28. • Интерактивные (realtime communications) • Неинтерактивные (push communications) • Пассивные, или «по запросу» (pull communications) Виды коммуникации
29. Телефонный разговор, чат, личная встреча… • Подразумевают быстрые вопросы и немедленные ответы • Не подразумевают «времени на обдумывание» • Подходят для решения срочных вопросов Интерактивные (realtime) коммуникации
30. Email, системы техподдержки… • Не подразумевают немедленного ответа • Дают возможность подумать над ответом • Подходят для несрочных вопросов Неинтерактивные (push) коммуникации
31. Базы знаний, wiki-системы, комплекты документации, индустриальные стандарты, онлайн-курсы, видеоинструкции… • Работают в режиме «вся информация уже выложена, читатель сам найдет ответ» • Самый медленный способ коммуникации Пассивные (pull) коммуникации
32. Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push
33. Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push
34. Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push
35. Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push
36. Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push
37. Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push
38. Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push
39. Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push
40. Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push
41. Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push
42. Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push
43. Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push
44. Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push
45. Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push
46. Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push
47. Позвонить по скайпу? Realtime Написать в телеграме? Push Написать email? Push Завести баг в проекте на GitHub? Push Разобраться в коде метода, который коллега написал два года назад? Pull Уточнить сигнатуру метода API в справочнике? Pull Поискать ответ на StackOverflow? Pull Задать вопрос на StackOverflow? Push
48. Техническая документация — пассивный (pull) способ реализации канала коммуникации между двумя четко определенными стейкхолдерами проекта.
49. Техническая документация — пассивный (pull) способ реализации канала коммуникации между двумя четко определенными стейкхолдерами проекта.
51. Спецификация требований
52. Спецификация требований Техзадание
53. Спецификация требований Техзадание Техзадание
54. Спецификация требований Техзадание Техзадание Справочник API
55. Спецификация требований Техзадание Техзадание Справочник API Архитектура решения
56. Спецификация требований Техзадание Техзадание Справочник API Архитектура решения Руководство пользователя
57. Спецификация требований Техзадание Техзадание Справочник API Архитектура решения Руководство пользователя Troubleshooting guide
58. Техническая документация — пассивный (pull) способ реализации канала коммуникации между двумя четко определенными стейкхолдерами проекта.
59. Не каждый канал проектной коммуникации необходимо форсированно реализовывать (на офисной кухне тоже много каналов коммуникации, и что?)
60. Документация — не единственно возможный способ реализации коммуникаций
61. Спецификация требований Техзадание Техзадание Справочник API Архитектура решения Руководство пользователя Troubleshooting guide
62. Спецификация требований Техзадание Справочник API Архитектура решения Руководство пользователя Troubleshooting guide Устные обсуждения
63. Спецификация требований Техзадание Справочник API Руководство пользователя Troubleshooting guide Устный онбординг Устные обсуждения
64. Спецификация требований Устные обсуждения Техзадание Справочник API Устный онбординг Руководство пользователя Устные консультации
65. Документация возникает тогда, когда остальные способы реализации этого канала коммуникации слишком дороги.
66. • Pull-коммуникация — самая дорогая. Push и realtime, чаще всего, дешевле • Документация возникает в краевых случаях дороговизны push- и realtime-коммуникации для конкретной пары стейкхолдеров Парадокс документации как коммуникации
67. Когда pull лучше, чем push и realtime?
68. • Когда количество «получателей» коммуникации велико Когда pull лучше, чем push и realtime?
69. • Когда количество «получателей» коммуникации велико • Сотни тысяч пользователей Когда pull лучше, чем push и realtime?
70. • Когда количество «получателей» коммуникации велико • Сотни тысяч пользователей • Проектная команда из 40 разработчиков Когда pull лучше, чем push и realtime?
71. • Когда количество «получателей» коммуникации велико • Сотни тысяч пользователей • Проектная команда из 40 разработчиков Когда pull лучше, чем push и realtime?
72. • Когда количество «получателей» коммуникации велико • Сотни тысяч пользователей • Проектная команда из 40 разработчиков • Когда стоимость ошибки велика Когда pull лучше, чем push и realtime?
73. • Когда количество «получателей» коммуникации велико • Сотни тысяч пользователей • Проектная команда из 40 разработчиков • Когда стоимость ошибки велика • Ошибка в устной передаче требований приведет к дорогой переделке системы Когда pull лучше, чем push и realtime?
74. • Ее нужно сесть и написать • Ее нужно тестировать и профилировать — действительно ли она хорошо реализует этот канал коммуникации? • Ее нужно поддерживать в актуальном состоянии Документация требует инвестиций
75. Если документация неэффективно реализует канал коммуникации, ей не будут пользоваться. И перейдут к другим способам (realtime и push)
76. Еще одно определение технической документации
77. Не всякая pull-коммуникация — документация
78. Не всякая pull-коммуникация — документация EULA
79. Не всякая pull-коммуникация — документация EULA
80. Не всякая pull-коммуникация — документация EULA Продающие тексты на сайте
81. Не всякая pull-коммуникация — документация EULA Продающие тексты на сайте
82. Не всякая pull-коммуникация — документация EULA Продающие тексты на сайте Видеоинструкция
83. Техническая документация — это набор текстовых материалов, описывающих разные аспекты •создания, •внутреннего устройства •и эксплуатации программного продукта.
84. Техническая документация — это набор текстовых материалов, описывающих разные аспекты •создания, •внутреннего устройства •и эксплуатации программного продукта.
85. • Project visions • Техзадания и спецификации требований • Проектные планы • Roadmap-ы развития продукта • Бэклоги фич? • Планы на спринт? Создание продукта
86. • Архитектура программного решения • Описание инфраструктуры • Инструкции по развертыванию рабочего окружения Внутреннее устройство продукта
87. • Руководства пользователя и администратора • Справочники API • Инструкции по инсталляции • “How to contribute” Использование продукта
88. • Документация — способ реализации канала pull- коммуникации между проектными стейкхолдерами • Эта коммуникация освещает аспекты создания, использования или внутреннего устройства продукта • Этот способ реализации канала коммуникации дешевле, чем push или realtime • Этот канал коммуникации реализуется текстом и изображениями Подытожим определения
89. Минимально необходимый набор документации
90. Какие технические документы нужны в моем проекте?
91. PMBOK: Communication Plan Карта стейкхолдеров и каналов коммуникации между ними
92. ISO/IEC/IEEE 12207 Software life cycle processes Documentation Plan Карта стейкхолдеров и список документов, которые будут реализовывать каналы коммуникации между ними
93. Спецификация требований Техзадание Техзадание Справочник API Архитектура решения Руководство пользователя Troubleshooting guide
94. «Принимающих» стейкхолдеров может быть больше, чем вы ожидаете
95. «Принимающих» стейкхолдеров может быть больше, чем вы ожидаете Руководство пользователя Troubleshooting guide
96. «Принимающих» стейкхолдеров может быть больше, чем вы ожидаете
97. Адресаты документации на API
98. • Я знаком с этим API, мне нужно посмотреть сигнатуру конкретного метода Адресаты документации на API
99. • Я знаком с этим API, мне нужно посмотреть сигнатуру конкретного метода • Я не знаком с этим API, мне нужно почитать примеры использования и пройти пару уроков Адресаты документации на API
100. • Я знаком с этим API, мне нужно посмотреть сигнатуру конкретного метода • Я не знаком с этим API, мне нужно почитать примеры использования и пройти пару уроков • Я знаком с конкурирующими API, мне нужно быстро понять, чем вы лучше Адресаты документации на API
101. Адресаты документации на API
102. Адресаты документации на API Справочник API API guides & tutorials Обзор возможностей API
103. Адресаты документации на API Справочник API API guides & tutorials Обзор возможностей API
104. • Обзор возможностей и целеполагание • Вводные уроки и поясняющие статьи • Справочник методов Документация на API — это не только Swagger
105. • Обзор возможностей и целеполагание • Вводные уроки и поясняющие статьи • Справочник методов Документация на API — это не только Swagger www.documentat.io
106. Как сделать так, чтобы документация появилась?
107. • Нарисуйте карту стейкходлеров Как сделать так, чтобы документация появилась?
108. • Нарисуйте карту стейкходлеров • Определите, какие каналы стоит реализовать в виде документации Как сделать так, чтобы документация появилась?
109. • Нарисуйте карту стейкходлеров • Определите, какие каналы стоит реализовать в виде документации • Напишите документацию для каждого из каналов Как сделать так, чтобы документация появилась?
110. Канал коммуникации = документ?
111. • Кто оба стейкхолдера (говорящий и принимающий?) Канал коммуникации = документ?
112. • Кто оба стейкхолдера (говорящий и принимающий?) • Зачем вообще реализовывать этот канал коммуникации? Зачем он проекту? А бизнесу? Канал коммуникации = документ?
113. • Кто оба стейкхолдера (говорящий и принимающий?) • Зачем вообще реализовывать этот канал коммуникации? Зачем он проекту? А бизнесу? • Точно ли документация — самый дешевый способ реализации этого канала? Канал коммуникации = документ?
114. Реализация канала коммуникации
115. • Каков контекст принимающего стейкхолдера? Что он знает и чего он не знает? Реализация канала коммуникации
116. • Каков контекст принимающего стейкхолдера? Что он знает и чего он не знает? • Что именно хочет сообщить «говорящий» стейкхолдер? Какие еще есть источники информации? Реализация канала коммуникации
117. • Каков контекст принимающего стейкхолдера? Что он знает и чего он не знает? • Что именно хочет сообщить «говорящий» стейкхолдер? Какие еще есть источники информации? • Как это правильно структурировать, написать и оформить? Реализация канала коммуникации
118. Технический писатель как имплементатор канала коммуникации
119. • Понять нужды стейкхолдеров Технический писатель как имплементатор канала коммуникации
120. • Понять нужды стейкхолдеров • Собрать, изучить и структурировать информацию Технический писатель как имплементатор канала коммуникации
121. • Понять нужды стейкхолдеров • Собрать, изучить и структурировать информацию • Спроектировать ее текстовое представление (чтобы канал коммуникации был реализован эффективно) Технический писатель как имплементатор канала коммуникации
122. • Понять нужды стейкхолдеров • Собрать, изучить и структурировать информацию • Спроектировать ее текстовое представление (чтобы канал коммуникации был реализован эффективно) • Написать понятный и грамотный текст Технический писатель как имплементатор канала коммуникации
123. • Понять нужды стейкхолдеров • Собрать, изучить и структурировать информацию • Спроектировать ее текстовое представление (чтобы канал коммуникации был реализован эффективно) • Написать понятный и грамотный текст Технический писатель как имплементатор канала коммуникации Это сложный и небанальный набор навыков. Они есть не у всех.
124. • Понять нужды стейкхолдеров • Собрать, изучить и структурировать информацию • Спроектировать ее текстовое представление (чтобы канал коммуникации был реализован эффективно) • Написать понятный и грамотный текст Технический писатель как имплементатор канала коммуникации www.documentat.io
125. • Нарисуйте карту стейкходлеров • Определите, какие каналы стоит реализовать в виде документации • Напишите документацию для каждого из каналов Как понять, какая документация нужна вашему продукту/проекту?
126. • Нарисуйте карту стейкхолдеров • Определите, какие каналы стоит реализовать в виде документации • Напишите документацию для каждого из каналов Как понять, какая документация нужна вашему продукту/проекту? Или позовите техписателя
127. • Техзадание, высокоуровневые бизнес-требования • SRS, функциональные и нефункциональные требования • Инструкция по развертыванию рабочего окружения • Инструкция по развертыванию продукта • Руководство пользователя • Документация на API • Архитектура решения • Онбординг новому сотруднику Чеклист документации для IT-продукта Документ Кому он адресован Техзадание (высокоуровневые бизнес- требования) Бизнесовые стейкхолдеры SRS, спецификация требований (функциональных и нефункциональных) Команда разработки Инструкция по настройке рабочего окружения Программисты Инструкция по установке/развертыванию Интеграторы клиента Руководство пользователя Конечные пользователи Документация на API: справочник, вводные/обучающие статьи Программисты (внешние и внутренние) Архитектурного программного решения: структура компонентов, модулей, классов… Программисты Документ «первого дня» для нового сотрудника: о чем проект, ссылки на основные ресурсы, ссылки на документацию… Программисты
128. • Техзадание, высокоуровневые бизнес-требования • SRS, функциональные и нефункциональные требования • Инструкция по развертыванию рабочего окружения • Инструкция по развертыванию продукта • Руководство пользователя • Документация на API • Архитектура решения • Онбординг новому сотруднику Чеклист документации для IT-продукта Документ Кому он адресован Зачем он Техзадание (высокоуровневые бизнес- требования) Бизнесовые стейкхолдеры SRS, спецификация требований (функциональных и нефункциональных) Команда разработки Инструкция по настройке рабочего окружения Программисты Инструкция по установке/развертыванию Интеграторы клиента Руководство пользователя Конечные пользователи Документация на API: справочник, вводные/обучающие статьи Программисты (внешние и внутренние) Архитектурного программного решения: структура компонентов, модулей, классов… Программисты Документ «первого дня» для нового сотрудника: о чем проект, ссылки на основные ресурсы, ссылки на документацию… Программисты
129. • Техзадание, высокоуровневые бизнес-требования • SRS, функциональные и нефункциональные требования • Инструкция по развертыванию рабочего окружения • Инструкция по развертыванию продукта • Руководство пользователя • Документация на API • Архитектура решения • Онбординг новому сотруднику Чеклист документации для IT-продукта Документ Кому он адресован Зачем он Техзадание (высокоуровневые бизнес- требования) Бизнесовые стейкхолдеры Снижение риска «сделать не то» SRS, спецификация требований (функциональных и нефункциональных) Команда разработки Инструкция по настройке рабочего окружения Программисты Инструкция по установке/развертыванию Интеграторы клиента Руководство пользователя Конечные пользователи Документация на API: справочник, вводные/обучающие статьи Программисты (внешние и внутренние) Архитектурного программного решения: структура компонентов, модулей, классов… Программисты Документ «первого дня» для нового сотрудника: о чем проект, ссылки на основные ресурсы, ссылки на документацию… Программисты
130. • Техзадание, высокоуровневые бизнес-требования • SRS, функциональные и нефункциональные требования • Инструкция по развертыванию рабочего окружения • Инструкция по развертыванию продукта • Руководство пользователя • Документация на API • Архитектура решения • Онбординг новому сотруднику Чеклист документации для IT-продукта Документ Кому он адресован Зачем он Техзадание (высокоуровневые бизнес- требования) Бизнесовые стейкхолдеры Снижение риска «сделать не то» SRS, спецификация требований (функциональных и нефункциональных) Команда разработки Снижение риска «сделать не то» Инструкция по настройке рабочего окружения Программисты Инструкция по установке/развертыванию Интеграторы клиента Руководство пользователя Конечные пользователи Документация на API: справочник, вводные/обучающие статьи Программисты (внешние и внутренние) Архитектурного программного решения: структура компонентов, модулей, классов… Программисты Документ «первого дня» для нового сотрудника: о чем проект, ссылки на основные ресурсы, ссылки на документацию… Программисты
131. • Техзадание, высокоуровневые бизнес-требования • SRS, функциональные и нефункциональные требования • Инструкция по развертыванию рабочего окружения • Инструкция по развертыванию продукта • Руководство пользователя • Документация на API • Архитектура решения • Онбординг новому сотруднику Чеклист документации для IT-продукта Документ Кому он адресован Зачем он Техзадание (высокоуровневые бизнес- требования) Бизнесовые стейкхолдеры Снижение риска «сделать не то» SRS, спецификация требований (функциональных и нефункциональных) Команда разработки Снижение риска «сделать не то» Инструкция по настройке рабочего окружения Программисты Ускорение онбординга Инструкция по установке/развертыванию Интеграторы клиента Руководство пользователя Конечные пользователи Документация на API: справочник, вводные/обучающие статьи Программисты (внешние и внутренние) Архитектурного программного решения: структура компонентов, модулей, классов… Программисты Документ «первого дня» для нового сотрудника: о чем проект, ссылки на основные ресурсы, ссылки на документацию… Программисты
132. • Техзадание, высокоуровневые бизнес-требования • SRS, функциональные и нефункциональные требования • Инструкция по развертыванию рабочего окружения • Инструкция по развертыванию продукта • Руководство пользователя • Документация на API • Архитектура решения • Онбординг новому сотруднику Чеклист документации для IT-продукта Документ Кому он адресован Зачем он Техзадание (высокоуровневые бизнес- требования) Бизнесовые стейкхолдеры Снижение риска «сделать не то» SRS, спецификация требований (функциональных и нефункциональных) Команда разработки Снижение риска «сделать не то» Инструкция по настройке рабочего окружения Программисты Ускорение онбординга Инструкция по установке/развертыванию Интеграторы клиента Снижение нагрузки на техподдержку Руководство пользователя Конечные пользователи Документация на API: справочник, вводные/обучающие статьи Программисты (внешние и внутренние) Архитектурного программного решения: структура компонентов, модулей, классов… Программисты Документ «первого дня» для нового сотрудника: о чем проект, ссылки на основные ресурсы, ссылки на документацию… Программисты
133. • Техзадание, высокоуровневые бизнес-требования • SRS, функциональные и нефункциональные требования • Инструкция по развертыванию рабочего окружения • Инструкция по развертыванию продукта • Руководство пользователя • Документация на API • Архитектура решения • Онбординг новому сотруднику Чеклист документации для IT-продукта Документ Кому он адресован Зачем он Техзадание (высокоуровневые бизнес- требования) Бизнесовые стейкхолдеры Снижение риска «сделать не то» SRS, спецификация требований (функциональных и нефункциональных) Команда разработки Снижение риска «сделать не то» Инструкция по настройке рабочего окружения Программисты Ускорение онбординга Инструкция по установке/развертыванию Интеграторы клиента Снижение нагрузки на техподдержку Руководство пользователя Конечные пользователи Снижение нагрузки на техподдержку Документация на API: справочник, вводные/обучающие статьи Программисты (внешние и внутренние) Архитектурного программного решения: структура компонентов, модулей, классов… Программисты Документ «первого дня» для нового сотрудника: о чем проект, ссылки на основные ресурсы, ссылки на документацию… Программисты
134. • Техзадание, высокоуровневые бизнес-требования • SRS, функциональные и нефункциональные требования • Инструкция по развертыванию рабочего окружения • Инструкция по развертыванию продукта • Руководство пользователя • Документация на API • Архитектура решения • Онбординг новому сотруднику Чеклист документации для IT-продукта Документ Кому он адресован Зачем он Техзадание (высокоуровневые бизнес- требования) Бизнесовые стейкхолдеры Снижение риска «сделать не то» SRS, спецификация требований (функциональных и нефункциональных) Команда разработки Снижение риска «сделать не то» Инструкция по настройке рабочего окружения Программисты Ускорение онбординга Инструкция по установке/развертыванию Интеграторы клиента Снижение нагрузки на техподдержку Руководство пользователя Конечные пользователи Снижение нагрузки на техподдержку Документация на API: справочник, вводные/обучающие статьи Программисты (внешние и внутренние) Снижение нагрузки на команду разработки Архитектурного программного решения: структура компонентов, модулей, классов… Программисты Документ «первого дня» для нового сотрудника: о чем проект, ссылки на основные ресурсы, ссылки на документацию… Программисты
135. • Техзадание, высокоуровневые бизнес-требования • SRS, функциональные и нефункциональные требования • Инструкция по развертыванию рабочего окружения • Инструкция по развертыванию продукта • Руководство пользователя • Документация на API • Архитектура решения • Онбординг новому сотруднику Чеклист документации для IT-продукта Документ Кому он адресован Зачем он Техзадание (высокоуровневые бизнес- требования) Бизнесовые стейкхолдеры Снижение риска «сделать не то» SRS, спецификация требований (функциональных и нефункциональных) Команда разработки Снижение риска «сделать не то» Инструкция по настройке рабочего окружения Программисты Ускорение онбординга Инструкция по установке/развертыванию Интеграторы клиента Снижение нагрузки на техподдержку Руководство пользователя Конечные пользователи Снижение нагрузки на техподдержку Документация на API: справочник, вводные/обучающие статьи Программисты (внешние и внутренние) Снижение нагрузки на команду разработки Архитектурного программного решения: структура компонентов, модулей, классов… Программисты Ускорение онбординга Документ «первого дня» для нового сотрудника: о чем проект, ссылки на основные ресурсы, ссылки на документацию… Программисты
136. • Техзадание, высокоуровневые бизнес-требования • SRS, функциональные и нефункциональные требования • Инструкция по развертыванию рабочего окружения • Инструкция по развертыванию продукта • Руководство пользователя • Документация на API • Архитектура решения • Онбординг новому сотруднику Чеклист документации для IT-продукта Документ Кому он адресован Зачем он Техзадание (высокоуровневые бизнес- требования) Бизнесовые стейкхолдеры Снижение риска «сделать не то» SRS, спецификация требований (функциональных и нефункциональных) Команда разработки Снижение риска «сделать не то» Инструкция по настройке рабочего окружения Программисты Ускорение онбординга Инструкция по установке/развертыванию Интеграторы клиента Снижение нагрузки на техподдержку Руководство пользователя Конечные пользователи Снижение нагрузки на техподдержку Документация на API: справочник, вводные/обучающие статьи Программисты (внешние и внутренние) Снижение нагрузки на команду разработки Архитектурного программного решения: структура компонентов, модулей, классов… Программисты Ускорение онбординга Документ «первого дня» для нового сотрудника: о чем проект, ссылки на основные ресурсы, ссылки на документацию… Программисты Ускорение онбординга
137. Документация — это про деньги. Эффективно реализованный канал коммуникации экономит трудозатраты и снижает риски.
138. • Документация — способ реализации канала коммуникации между стейкхолдерами • Не каждый канал должен быть реализован документацией • Техписатель — имплементатор этого канала • Документация — это про деньги Подытожим
139. • Документация не радует: почему так получилось и что делать • Документация: процесс или артефакт? Да! • Типовые процессы вокруг документации В следующей серии
140. • Заказная разработка документации • Консалтинг и настройка процессов • Бесплатный аудит вашей документации Обязательная минутка рекламы www.documentat.io