Клуб технических писателей

Клуб технических писателей

Вопросы по докладу "Построить и научить" (Светлана Каюшина)

Добрый день. Спасибо за ваш доклад. Ответьте, пожалуйста, на несколько вопросов:

  1. В докладе говорилось о 300 документах, которые разрабатываются силами технических писателей. Что вы понимаете под документом?
  2. Кто является заказчиком для технических писателей? Как задачи попадают в отдел?
  3. Разработка документов начинается после окончания разработки кода?

Спасибо. 

2 комментария
Авторизуйтесь, чтобы оставить комментарий
sveta-kaushina
28 января 2016, 03:15

Добрый день!

1. Документ — это документ определенного типа на сервис или технологию. Объем документов разнится от 20 до 700-800 страниц (A4 в PDF). Приведу примеры для наглядности.

  Помощь к браузеру Yandex — совокупность веб-страниц, собранных под урлом http://help.yandex.ru/yabrowser/.

  Руководство разработчика JS API Яндекс.Карт — совокупность веб-страниц, собранных под урлом https://tech.yandex.ru/maps/doc/jsapi/2.1/dg/

2. Зависит от типа документа. Справку к сервисам заказывают обычно менеджеры проектов, реже — сотрудники техподдержки. Техническую документацию на API и технологии — разработчики и менеджеры проектов/продуктов.

3. По-разному. Мы предпочитаем начинать документирование, когда продукт передан в тестирование.

Alexander Bondarchuk
28 января 2016, 03:15

Светлана, спасибо!