Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

После нас - хоть потоп! Как писать документацию на века

1,099 views

Published on

Доклад Кристины Ерофеевой на конференции Analyst Days-4,
17-18 апреля 2015 г., Минск
www.analystdays.com

Published in: Education
  • Be the first to comment

После нас - хоть потоп! Как писать документацию на века

  1. 1. Group Technology & Operations Deutsche Bank После нас – хоть потоп! Как писать документацию на века 0
  2. 2. Kristina Erofeeva Analyst Days 2015Group Technology & Operations Deutsche Bank — Меня зовут Кристина  — Училась на экономиста — Работаю аналитиком программного обеспечения ~9 лет — Аналитик «по призванию» Доклад отражает личное мнение и взгляды автора, которые могут не совпадать с мнением и позицией ООО «Технологический Центр Дойче Банка» Об авторе
  3. 3. Kristina Erofeeva Analyst Days 2015Group Technology & Operations Deutsche Bank — Работает, и непонятно «баг или фича» — Надо исправить, но непонятно какая часть с проблемой — Непонятно, как работает вообще — Надо переписать с сохранением функциональности, а требований нет Приходите вы на проект, а там..
  4. 4. Group Technology & Operations Deutsche Bank Kristina Erofeeva Analyst Days 2015 Каким может быть новый для вас проект?.. Проект новый Проекту 3-5 лет 4/19/2015 9:34:29 AM 2010 DB Blue template 3 Проекту 5-10 лет Проекту больше 10 лет — Системы нет — Накопленной экпертизы нет — Документации нет — Команда/бизнес поменялись — Среда и технологии поменялись — Система в эксплуатации — Бизнес и команда доступны — Среда не поменялась — Экспертиза утеряна — Существенно поменялась среда и технологии
  5. 5. Kristina Erofeeva Analyst Days 2015Group Technology & Operations Deutsche Bank Какая документация есть на проекте? — Кого поймал – тот и документация! (Задачи в трекере, код, требования, документы по тестированию) 4 — Много описания реализации, мало описания цели — Детали среды, очевидные много лет назад, утеряны сейчас — Отсутствие нескольких документов = отсутствие целостности
  6. 6. Kristina Erofeeva Analyst Days 2015Group Technology & Operations Deutsche Bank Какой документация должна быть? — Подробнее? 5 — О другом? — В другом формате? — Что бы вы сделали по другому? — Больше?
  7. 7. Kristina Erofeeva Analyst Days 2015Group Technology & Operations Deutsche Bank Задокументировать: Контекст использования, динамику — Какие пользователи, в какой момент времени этим пользуются (хотят пользоваться)? 6 — При изменении каких условий пользователи перестанут этим пользоваться? — Что делают пользователи сейчас без этого, как справляются?
  8. 8. Kristina Erofeeva Analyst Days 2015Group Technology & Operations Deutsche Bank Добавить конкретику: Бизнес-среда — Законы (номера, даты) 7 — Бизнес-правила (названия регулирующих организаций, название свода правил) — Системы, с которыми есть тесное взаимодействие
  9. 9. Kristina Erofeeva Analyst Days 2015Group Technology & Operations Deutsche Bank Помечтать: Ограничения — То, что выглядит неудобным – неудобно! 8 — Представьте, что идеальный сферический мир в вакууме существует  через 10+ лет
  10. 10. Kristina Erofeeva Analyst Days 2015Group Technology & Operations Deutsche Bank Уделить внимание: Текстовый поиск — Называйте главы подробно 9 — Перефразируйте — Употребляйте термины однозначно — Храните все документы в едином месте
  11. 11. Kristina Erofeeva Analyst Days 2015Group Technology & Operations Deutsche Bank Применить: Уникальные сокращения — Loan Contract / List of Confirmations / Letter of Cedit / Legal Constraints 10 — Уникальность в рамках проекта — Несовпадение сокращений с терминами (ACK, ERR, ACC, SALE... )
  12. 12. Kristina Erofeeva Analyst Days 2015Group Technology & Operations Deutsche Bank Структурировать: Независимость документов — Детали – отдельно, суть – повторять 11 — Документация – не код
  13. 13. Kristina Erofeeva Analyst Days 2015Group Technology & Operations Deutsche Bank Итого: — Важны цели разработки, не только детали реализации 12 — Важны детали среды — Важны ограничения — Помогают текстовый поиск и уникальность сокращений — Помогает умеренное повторение общего контента
  14. 14. Group Technology & Operations Deutsche Bank Kristina Erofeeva Analyst Days 2015 Конфликт интересов Сегодня Через 10 лет 4/19/2015 9:34:29 AM 2010 DB Blue template 13 Для разработки нужно описание «как». Видимый результат работы зависит от достаточности документа для разработки Время ограничено Отложенный результат работы приносит пользу компании, но не аналитику, который вкладывал в этот результат
  15. 15. Kristina Erofeeva Analyst Days 2015Group Technology & Operations Deutsche Bank 14 Спасибо за внимание Вопросы?

×