(#3) Техническая документация в IT-проектах. Жизненные циклы технических документов

http://documentat.io/sdo

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

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

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

Лекция 3. Типичные процессы вокруг документации. Жизненный цикл технического документа.

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

Transcript

1. www.documentat.io Семëн Факторович sam@documentat.io Техническая документация в IT-проектах
2. • Консалтинг и настройка процессов документирования • Заказная разработка документации • Бесплатный аудит вашей документации Обязательная минутка рекламы www.documentat.io
3. В предыдущей серии
4. В предыдущей серии
5. • Документация — артефакт В предыдущей серии
6. • Документация — артефакт • Требования к нему, постановка задачи В предыдущей серии
7. • Документация — артефакт • Требования к нему, постановка задачи • Критерии качества В предыдущей серии
8. • Документация — артефакт • Требования к нему, постановка задачи • Критерии качества В предыдущей серии
9. • Документация — артефакт • Требования к нему, постановка задачи • Критерии качества • Документация — процесс В предыдущей серии
10. • Документация — артефакт • Требования к нему, постановка задачи • Критерии качества • Документация — процесс • В какой момент нужно за нее браться? В предыдущей серии
11. • Документация — артефакт • Требования к нему, постановка задачи • Критерии качества • Документация — процесс • В какой момент нужно за нее браться? • Процессы постановки задачи и контроля качества В предыдущей серии
12. • Процессы работы с документацией • Жизненные циклы технических документов О чем говорим сегодня
13. Техническая документация vs. технический документ
14. Техническая документация — это… pull-способ реализации канала коммуникации между проектными стейкхолдерами, описывающий аспекты •создания, •эксплуатации, •или внутреннего устройства программного продукта, и реализуемый текстом и/или графикой.
15. Техническая документация — pull-способ реализации канала коммуникации между проектными стейкхолдерами, описывающий аспекты •создания, •эксплуатации, •или внутреннего устройства программного продукта, и реализуемый текстом и/или графикой.
16. Техническая документация — pull-способ реализации канала коммуникации между проектными стейкхолдерами, описывающий аспекты •создания, •эксплуатации, •или внутреннего устройства программного продукта, и реализуемый текстом и/или графикой.
18. Технический документ — это… проектный артефакт технической документации, связывающий двух определенных стейкхолдеров и являющийся обособленной единицей в терминах •целеполагания, •контроля качества, •и публикации.
19. Технический документ — проектный артефакт технической документации, связывающий двух определенных стейкхолдеров и являющийся обособленной единицей в терминах •целеполагания, •контроля качества, •и публикации.
20. Технический документ — проектный артефакт технической документации, связывающий двух определенных стейкхолдеров и являющийся обособленной единицей в терминах •целеполагания, •контроля качества, •и публикации.
21. Артефакт + процесс вокруг него = жизненный цикл
22. Жизненный цикл технического документа
24. Постановка задачи
25. Постановка задачи
26. • Каких двух стейкхолдеров мы связываем? • Зачем это им? • Зачем этот канал коммуникации бизнесу? Постановка задачи
28. Извлечение информации
29. Интервьюирование стейкхолдеров
30. Интервьюирование стейкхолдеров
31. Интервьюирование стейкхолдеров
32. Готовимся к интервью
33. • Точно ли мы говорим с парой стейкхолдеров? (а не с их менеджерами, например) Готовимся к интервью
34. • Точно ли мы говорим с парой стейкхолдеров? (а не с их менеджерами, например) • Точно ли оба стейкхолдера понимают, о каком канале коммуникации идет речь? Готовимся к интервью
35. • Точно ли мы говорим с парой стейкхолдеров? (а не с их менеджерами, например) • Точно ли оба стейкхолдера понимают, о каком канале коммуникации идет речь? • Точно ли оба стейкхолдера понимают, что мы облегчаем им жизнь? Готовимся к интервью
36. Интервью
37. Интервью «Мы сейчас настраиваем канал коммуникации между вами, чтобы…»
38. Интервью «Мы сейчас настраиваем канал коммуникации между вами, чтобы…» О чем вы хотели бы рассказать?
39. Интервью «Мы сейчас настраиваем канал коммуникации между вами, чтобы…» О чем вы хотели бы рассказать? Что вы хотели бы услышать?
41. • Наиболее эффективная реализация канала коммуникации с учетом нужд стейкхолдеров • Весь фронт информации • Структура • Стиль • Язык Написание документа
43. • Верна и полна ли изложенная информация? • Хорошо ли всё структурировано? Читаемо ли? • Есть ли орфографические ошибки? • Хорошо ли оформлено? Проверка документа
44. • Вычитка • Редактура • Корректура • Фактчекинг • Проверка Проверка документа
45. • Вычитка • Редактура • Корректура • Фактчекинг • Проверка Ревью (review)
46. • Стейхколдер А должен проверить факты • Стейкхолдер Б может проверить полноту фактов и ясность изложения • Другой техписатель может проверить стиль и структуру • Редактор может проверить соответствие корпоративным гайдлайнам • И т.д. Ревью
47. Ревью — процесс с множеством участников
48. Ревью — процесс с множеством участников И множеством итераций
61. Ревью — процесс с множеством участников И множеством итераций
62. Ревью — процесс с множеством участников И множеством итераций И своеобразными требованиями к инструментарию
63. documentat.io/courses
65. Приемка
66. • Формальный организационный момент завершения ревью Приемка
67. • Формальный организационный момент завершения ревью • «Все заинтересованные лица сказали, что документ в порядке» Приемка
68. • Формальный организационный момент завершения ревью • «Все заинтересованные лица сказали, что документ в порядке» • Теперь его можно отдавать читателям Приемка
70. Публикация
71. • Точка водораздела между рабочей копией и копией, доступной читателю Публикация
72. • Точка водораздела между рабочей копией и копией, доступной читателю Публикация
73. • Точка водораздела между рабочей копией и копией, доступной читателю • Скорее всего, включает в себя перевод в какой-то другой формат (PDF, HTML…) Публикация
76. • ЖЦ документа (даже простейший) требует настройку различных процессов вокруг себя • В них задействованы не только техписатели • Все эти процессы сильно завязаны на инструментарий Подытожим
77. • Требования к ЖЦ → требования к документационному инструментарию • Классы документационного инструментария В следующей серии
78. • Консалтинг и настройка процессов документирования • Заказная разработка документации • Бесплатный аудит вашей документации Обязательная минутка рекламы www.documentat.io