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

Slide 1

Slide 1 text

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

Slide 2

Slide 2 text

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

Slide 3

Slide 3 text

В предыдущей серии

Slide 4

Slide 4 text

В предыдущей серии

Slide 5

Slide 5 text

• Документация — артефакт В предыдущей серии

Slide 6

Slide 6 text

• Документация — артефакт • Требования к нему, постановка задачи В предыдущей серии

Slide 7

Slide 7 text

• Документация — артефакт • Требования к нему, постановка задачи • Критерии качества В предыдущей серии

Slide 8

Slide 8 text

• Документация — артефакт • Требования к нему, постановка задачи • Критерии качества В предыдущей серии

Slide 9

Slide 9 text

• Документация — артефакт • Требования к нему, постановка задачи • Критерии качества • Документация — процесс В предыдущей серии

Slide 10

Slide 10 text

• Документация — артефакт • Требования к нему, постановка задачи • Критерии качества • Документация — процесс • В какой момент нужно за нее браться? В предыдущей серии

Slide 11

Slide 11 text

• Документация — артефакт • Требования к нему, постановка задачи • Критерии качества • Документация — процесс • В какой момент нужно за нее браться? • Процессы постановки задачи и контроля качества В предыдущей серии

Slide 12

Slide 12 text

• Процессы работы с документацией • Жизненные циклы технических документов О чем говорим сегодня

Slide 13

Slide 13 text

Техническая документация vs. технический документ

Slide 14

Slide 14 text

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

Slide 15

Slide 15 text

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

Slide 16

Slide 16 text

Slide 17

Slide 17 text

No content

Slide 18

Slide 18 text

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

Slide 19

Slide 19 text

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

Slide 20

Slide 20 text

Slide 21

Slide 21 text

Артефакт + процесс вокруг него = жизненный цикл

Slide 22

Slide 22 text

Жизненный цикл технического документа

Slide 23

Slide 23 text

No content

Slide 24

Slide 24 text

Постановка задачи

Slide 25

Slide 25 text

Постановка задачи

Slide 26

Slide 26 text

• Каких двух стейкхолдеров мы связываем? • Зачем это им? • Зачем этот канал коммуникации бизнесу? Постановка задачи

Slide 27

Slide 27 text

No content

Slide 28

Slide 28 text

Извлечение информации

Slide 29

Slide 29 text

Интервьюирование стейкхолдеров

Slide 30

Slide 30 text

Интервьюирование стейкхолдеров

Slide 31

Slide 31 text

Интервьюирование стейкхолдеров

Slide 32

Slide 32 text

Готовимся к интервью

Slide 33

Slide 33 text

• Точно ли мы говорим с парой стейкхолдеров? (а не с их менеджерами, например) Готовимся к интервью

Slide 34

Slide 34 text

• Точно ли мы говорим с парой стейкхолдеров? (а не с их менеджерами, например) • Точно ли оба стейкхолдера понимают, о каком канале коммуникации идет речь? Готовимся к интервью

Slide 35

Slide 35 text

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

Slide 36

Slide 36 text

Интервью

Slide 37

Slide 37 text

Интервью «Мы сейчас настраиваем канал коммуникации между вами, чтобы…»

Slide 38

Slide 38 text

Интервью «Мы сейчас настраиваем канал коммуникации между вами, чтобы…» О чем вы хотели бы рассказать?

Slide 39

Slide 39 text

Интервью «Мы сейчас настраиваем канал коммуникации между вами, чтобы…» О чем вы хотели бы рассказать? Что вы хотели бы услышать?

Slide 40

Slide 40 text

No content

Slide 41

Slide 41 text

• Наиболее эффективная реализация канала коммуникации с учетом нужд стейкхолдеров • Весь фронт информации • Структура • Стиль • Язык Написание документа

Slide 42

Slide 42 text

No content

Slide 43

Slide 43 text

• Верна и полна ли изложенная информация? • Хорошо ли всё структурировано? Читаемо ли? • Есть ли орфографические ошибки? • Хорошо ли оформлено? Проверка документа

Slide 44

Slide 44 text

• Вычитка • Редактура • Корректура • Фактчекинг • Проверка Проверка документа

Slide 45

Slide 45 text

• Вычитка • Редактура • Корректура • Фактчекинг • Проверка Ревью (review)

Slide 46

Slide 46 text

• Стейхколдер А должен проверить факты • Стейкхолдер Б может проверить полноту фактов и ясность изложения • Другой техписатель может проверить стиль и структуру • Редактор может проверить соответствие корпоративным гайдлайнам • И т.д. Ревью

Slide 47

Slide 47 text

Ревью — процесс с множеством участников

Slide 48

Slide 48 text

Ревью — процесс с множеством участников И множеством итераций

Slide 49

Slide 49 text

No content

Slide 50

Slide 50 text

No content

Slide 51

Slide 51 text

No content

Slide 52

Slide 52 text

No content

Slide 53

Slide 53 text

No content

Slide 54

Slide 54 text

No content

Slide 55

Slide 55 text

No content

Slide 56

Slide 56 text

No content

Slide 57

Slide 57 text

No content

Slide 58

Slide 58 text

No content

Slide 59

Slide 59 text

No content

Slide 60

Slide 60 text

No content

Slide 61

Slide 61 text

Ревью — процесс с множеством участников И множеством итераций

Slide 62

Slide 62 text

Ревью — процесс с множеством участников И множеством итераций И своеобразными требованиями к инструментарию

Slide 63

Slide 63 text

documentat.io/courses

Slide 64

Slide 64 text

No content

Slide 65

Slide 65 text

Приемка

Slide 66

Slide 66 text

• Формальный организационный момент завершения ревью Приемка

Slide 67

Slide 67 text

• Формальный организационный момент завершения ревью • «Все заинтересованные лица сказали, что документ в порядке» Приемка

Slide 68

Slide 68 text

• Формальный организационный момент завершения ревью • «Все заинтересованные лица сказали, что документ в порядке» • Теперь его можно отдавать читателям Приемка

Slide 69

Slide 69 text

No content

Slide 70

Slide 70 text

Публикация

Slide 71

Slide 71 text

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

Slide 72

Slide 72 text

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

Slide 73

Slide 73 text

• Точка водораздела между рабочей копией и копией, доступной читателю • Скорее всего, включает в себя перевод в какой-то другой формат (PDF, HTML…) Публикация

Slide 74

Slide 74 text

No content

Slide 75

Slide 75 text

No content

Slide 76

Slide 76 text

• ЖЦ документа (даже простейший) требует настройку различных процессов вокруг себя • В них задействованы не только техписатели • Все эти процессы сильно завязаны на инструментарий Подытожим

Slide 77

Slide 77 text

• Требования к ЖЦ → требования к документационному инструментарию • Классы документационного инструментария В следующей серии