ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои...
-
Upload
intervale -
Category
Technology
-
view
136 -
download
2
description
Transcript of ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои...
![Page 1: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/1.jpg)
www.intervale.ru
2013 Светлана Милачева, Intervale
Опыт организации ОТД в IT-компании
Усы, лапы и хвост – вот мои документы.
Эволюция «хомяков»
![Page 2: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/2.jpg)
13.04.23 2www.intervale.ru
Обо мне
9 лет в IT•дизайн, •разработка, •администрирование, •сопровождение и поддержка ПО, •техписательство, •внедрение ПО, •начальник ОЭД.
Образование•ГГУ им. Ф.Скорины•МИЭМ.
Дополнительно•Курсы, он-лайн курсы•Профильные конференции.
![Page 3: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/3.jpg)
13.04.23 3www.intervale.ru
Определение понятий
*Хомяк Кто: исчезающий в 21 веке вид homepage (англ. домашняя страничка). Когда: был популярен в 20 веке, в эпоху зарождения IT-индустрии, до появления соцсетей.Среда обитания: водится в маленьких компаниях, где пока еще нет острой необходимости в грамотно построенном процессе документирования выпускаемых продуктов.
Кустарно сделанный продукт (в нашем случае – документ(ы)), например, написанный «на коленке», созданный непрофессионалом, не отвечающий высоким требованиям потребителя и не являющийся конкурентно- и жизнеспособным в современных рыночных условиях.
![Page 4: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/4.jpg)
13.04.23 4www.intervale.ru
Определение понятий
*ОТДЧто: отдел технической документации (более узко - ОЭД).Среда обитания: водится в заботливых IT-компаниях.
![Page 5: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/5.jpg)
13.04.23 5www.intervale.ru
Определение понятий
*Усы, лапы и хвост – это неофициальный докУмент (Усы, лапы и хвост – вот мои документы (с))Посылку вам по нему не выдадут!
![Page 6: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/6.jpg)
13.04.23 6www.intervale.ru
Главная тема
Роскошь или
Необходимость
ОТД в IT-компании
![Page 7: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/7.jpg)
13.04.23 7www.intervale.ru
Когда и зачем
Итак, если у вас наблюдается подобная картина
![Page 8: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/8.jpg)
13.04.23 8www.intervale.ru
Когда и зачем
Очень много документов. А-А-А!
![Page 9: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/9.jpg)
13.04.23 9www.intervale.ru
Когда и зачем
Что где лежит? А-А-А!
![Page 10: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/10.jpg)
13.04.23 10www.intervale.ru
Когда и зачем
Никто уже и не помнит, как это работает.А-А-А!
![Page 11: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/11.jpg)
13.04.23 11www.intervale.ru
Когда и зачем
Новые сотрудники, а объяснять некогда. И некому. Или и то и другое одновременно. А-А-А!
![Page 12: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/12.jpg)
13.04.23 12www.intervale.ru
Зачем
Документацию пишут разработчики«На этом имплементация завершена! Happy coding».А-А-А!
![Page 13: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/13.jpg)
13.04.23 13www.intervale.ru
Когда и зачем
Кажется, бардак начинается… А-А-А!
![Page 14: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/14.jpg)
13.04.23 14www.intervale.ru
Когда и зачем
Если у вас•накопилось много документов•непонятно, что где лежит•и кто за что отвечает•и как это работает•новые сотрудники, а объяснять некогда•наблюдается «happy coding».
![Page 15: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/15.jpg)
13.04.23 15www.intervale.ru
Когда и зачем
Если ваш Продукт на рынке должен выглядеть также презентабельно, как Вы на деловой встрече…
![Page 16: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/16.jpg)
13.04.23 16www.intervale.ru
Когда и зачем
То это знак. Пора!
![Page 17: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/17.jpg)
13.04.23 17www.intervale.ru
Пора
Пора прокачать вашего «хомяка»!
![Page 18: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/18.jpg)
13.04.23 18www.intervale.ru
Эволюция
Step by Step
![Page 19: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/19.jpg)
13.04.23 19www.intervale.ru
Перед стартом
С чего начинать?
![Page 20: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/20.jpg)
13.04.23 20www.intervale.ru
Обязательные вопросы
Прежде чем инициировать создание отдела, ответьте на вопросы:•Когда•Зачем•Зоны ответственности •Где искать людей•Как обучать•В чем писать•Где хранить•Перспективы
Бизнес-план.
![Page 21: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/21.jpg)
Команда
Ищите фанатов с горящими глазами.
13.04.23 21www.intervale.ru
![Page 22: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/22.jpg)
Команда
Из разных сфер (лингвисты, маркетологи, математики, IT-шники, медики, музыканты, специалисты банковской сферы…).
13.04.23 22www.intervale.ru
![Page 23: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/23.jpg)
Команда
С разными взглядами.
13.04.23 23www.intervale.ru
![Page 24: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/24.jpg)
Команда
С разным менталитетом и темпераментом.
13.04.23 24www.intervale.ru
![Page 25: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/25.jpg)
Среда обитания
• jobs.ru, hh.ru и др.• ВУЗы• Соцсети• Хантинг (вне
компании)• Среди знакомых
своих коллег• Хантить среди
коллег в своей компании
нельзя. Вернется бумерангом.
13.04.23 25www.intervale.ru
Где брать самые лучшие кадры
![Page 26: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/26.jpg)
Как обучать
• Мастер-классы.• Конференции, смежные по тематике. • Тренинги.• Перекрестное обучение.• Подружите коллег внутри и вне отдела и они сами друг друга
научат.• В IT-сфере очень важную роль играет самообучение.
13.04.23 26www.intervale.ru
![Page 27: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/27.jpg)
Распределение работ
Как делить работу и распределять нагрузку•По интересам.•По темпераменту.•По опыту и способностям.•По направлениям.•По продуктам.•По командам.
13.04.23 27www.intervale.ru
![Page 28: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/28.jpg)
Точки над “I”
Эта информация должна быть прозрачна для вас и ваших коллег•FAQ.•Каталог услуг.•Зоны ответственности.•Цели.•Задачи.•Стандарты.•Регламент.•Шаблоны.•Процедуры.
13.04.23 28www.intervale.ru
![Page 29: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/29.jpg)
Стандарты
ГОСТ, ISO?А может бытьсобственный
корпоративный стандарт?
13.04.23 29www.intervale.ru
![Page 30: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/30.jpg)
Каталог услуг
Каталог услуг отдела
13.04.23 30www.intervale.ru
![Page 31: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/31.jpg)
Инструменты
Инструменты по извлечению информации из разработчиков
13.04.23 31www.intervale.ru
![Page 32: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/32.jpg)
Инструменты
Создание и верстка документов•MS Word и пр. текстовые процессоры•MikTeX и пр. TeX-и•DocBook, DITA•Syntext Serna •Help&Manual.
13.04.23 32www.intervale.ru
![Page 33: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/33.jpg)
Где хранить
13.04.23 33www.intervale.ru
Единое хранилище документации
Можно, конечно, и так.Но лучше использовать единое хранилище.
![Page 34: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/34.jpg)
Где хранить
13.04.23 34www.intervale.ru
![Page 35: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/35.jpg)
Confluence
13.04.23 35www.intervale.ru
![Page 36: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/36.jpg)
SVN
13.04.23 36www.intervale.ru
![Page 37: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/37.jpg)
MS SharePoint
13.04.23 37www.intervale.ru
![Page 38: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/38.jpg)
Актуализация
Как и когда обновлять документацию•Точечно (мелкие баги, небольшие доработки не в рамках релиза); глобально (морально устарела, неактуальна).•В соответствии с релизной политикой.
Если релизная политика на проекте отсутствует, то ее нужно придумать и внедрить самостоятельно применимо к вашей части на проекте. Например, раз в месяц вы будете проверять статус предмета документирования (ПО, среда, система и т.д.) и обновлять документ\пакет документов.
13.04.23 38www.intervale.ru
![Page 39: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/39.jpg)
Контроль качества
Узнайте мнение о своей работе у пользователей документа (коллег и заказчиков) одним из способов, перечисленных ниже.Способы оценки (не человека, а работы ОТД)•Запросите фидбеки.•Передайте на ревью. •Проведите кросс-ревью.•Проинтервьюируйте заказчика.
13.04.23 39www.intervale.ru
![Page 40: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/40.jpg)
Карьера
13.04.23 40www.intervale.ru
![Page 41: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/41.jpg)
Планы и перспективы
Должны быть!Слушайте своих сотрудников. Они – главные источники идей!
13.04.23 41www.intervale.ru
![Page 42: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/42.jpg)
13.04.23 42www.intervale.ru
Легенда
Все персонажи вымышленные, все совпадения случайны.
![Page 43: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/43.jpg)
13.04.23 43www.intervale.ru
Вопросы
?
![Page 44: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/44.jpg)
13.04.23 44www.intervale.ru
Спасибо за внимание
Как со мной связаться•E-mail: [email protected]•Skype: smilacheva•Соцсети.
Спасибо за внимание и до новых встреч!
![Page 45: ТехДок 2013. С.Милачёва. Усы, лапы и хвост – вот мои документы. Эволюция «хомяков»](https://reader037.fdocuments.net/reader037/viewer/2022102722/557eba99d8b42ad27b8b4c5c/html5/thumbnails/45.jpg)
Источники иллюстраций
• poprage.deviantart.com• Рекламный ролик Kia Soul 2014 Hamster.
13.04.23 45www.intervale.ru