Перейти к содержимому

Школа для начинающих тестировщиков
онлайн, начало 14 ноября
Тестирование REST API
онлайн, начало 18 ноября
Python для начинающих
онлайн, начало 13 ноября
Selenium WebDriver: полное руководство
онлайн, начало 15 ноября
Фотография

Технический писатель - кто он?


  • Авторизуйтесь для ответа в теме
Сообщений в теме: 10

#1 Green

Green

    Гуру

  • Members
  • PipPipPipPipPipPip
  • 1 233 сообщений
  • ФИО:Гринкевич Сергей
  • Город:Москва

Отправлено 25 Февраль 2008 - 18:57

Коллеги!

Как правило в проекте существует отдельная роль, в задачи которой входит подготовка технической документации. За эту работу отвечает технический писатель.

Кто в ваших проектах занимается написанием технической документации (проектной, help-ом, набором обучающих документов и т.п.)?
  • 0
Гринкевич Сергей

#2 Vasiliy

Vasiliy

    Гуру

  • Members
  • PipPipPipPipPipPip
  • 2 632 сообщений
  • ФИО:Касимов Василий
  • Город:Москва

Отправлено 26 Февраль 2008 - 08:57

Технический писатель этим занимается.
Полтора человека на всю контору.
Хелпы, справки, документация - все к нему. Плюс так же переводы на русский язык.
  • 0

#3 Green

Green

    Гуру

  • Members
  • PipPipPipPipPipPip
  • 1 233 сообщений
  • ФИО:Гринкевич Сергей
  • Город:Москва

Отправлено 26 Февраль 2008 - 09:19

Технический писатель этим занимается.
Полтора человека на всю контору.
Хелпы, справки, документация - все к нему. Плюс так же переводы на русский язык.


В том то и дело, что далеко не во всех проектах, которые я знаю, привлекался технический писатель для оформления тех документации. И это при том, что в конторе есть техписы.

Видно такая же проблема у других производителей софта. Читая хелпы и доки других контор я зачастую не понимаю что в них написано. И не потому, что я плохо знаю русский. В первую очередь из=за того, что люди сами не знают, что нужно и можно делать с программой.
  • 0
Гринкевич Сергей

#4 Bishop_

Bishop_

    Новый участник

  • Members
  • Pip
  • 64 сообщений
  • ФИО:Дмитрий


Отправлено 26 Февраль 2008 - 11:52

У нас Аналитик занимается приведенными выше активностями
  • 0
<span style='font-size:8pt;line-height:100%'>Luxoft UA</span>

#5 Vasiliy

Vasiliy

    Гуру

  • Members
  • PipPipPipPipPipPip
  • 2 632 сообщений
  • ФИО:Касимов Василий
  • Город:Москва

Отправлено 26 Февраль 2008 - 14:41

К сожалению, не всегда наличие тех. писа спасает справку от подобной участи непонимания.
По-хорошему должен еще кто-то проверить, что все что описано красивым языком в мануале можно применить на практике при работе с программой. Жаль вот только это уже не всегда удается сделать.
Green, а кто же тогда в этих проектах занимался документацией, если писатель есть, но он не привлекается.
  • 0

#6 LeshaL

LeshaL

    Гуру

  • Members
  • PipPipPipPipPipPip
  • 1 094 сообщений
  • ФИО:Алексей Лянгузов
  • Город:Saint-Petersburg


Отправлено 26 Февраль 2008 - 14:53

Коллеги!

Как правило в проекте существует отдельная роль, в задачи которой входит подготовка технической документации. За эту работу отвечает технический писатель.

Кто в ваших проектах занимается написанием технической документации (проектной, help-ом, набором обучающих документов и т.п.)?

Привет!
У нас этим занимаются многие. Т.к. много разной технической документации бывает.
Для понятности, мы работаем над созданием сертификационных продуктов для Java API (в частности, для МЕ, таких как MIDP).
1) JavaDoc спецификации пишут специальные люди (specwriter-ы) - они хорошо понимают разрабатываемую технологию и, собственно, ее придумывают вместе с инженерами, которые имплементируют технологию или проверяют ее.
2) Техническую документацию проекта (внутреннюю) пишут девелоперы, по каким-то шаблонам, скорее всего.
3) Внешнюю документацию (Users Guide, help и тд) - пишут специальный люди (docwriter-ы). В основном, они переводчики с англиского на английский :) Информация к ним поступает от разработчиков и тестеров - они ее пишут правильными английскими словами и предложениями. В продукте зачастую разбираются плохо (в специфике конкретной технологии).
  • 0
Regards,
Alexey

#7 sgreeen

sgreeen

    Новый участник

  • Members
  • Pip
  • 47 сообщений
  • ФИО:Зульфия Чамшутова
  • Город:Узбекистан

Отправлено 04 Март 2008 - 07:22

Доброй время суток!!

За оформления внешней документаци (Инструкции по использованию и т.д.), которая ориентирована на конецного пользователя, пишется QA командой . Так как они есть последнии люди кто прикасался к приолжению и знают работающий функционал. После этого дается на прочетения проектноной команде и нескольким постороним и собираются замечания по документации.
В крупных организациях есть выделеный человек для этих целий. Делает тоже самое.
Можно нанять фрилансера но есть риск, что будет некачественая документация (обшики, неполная т.п.), что краней не советую. Практически напише все сами он только деньги возмет. Эфекта ноль
:victory:

Про внутрению документаци молчу так зависет от процесса разработки ПО
  • 0
рукоблуд
_____________________
За что же, не боясь греха,
Кукушка хвалит Петуха?
За то, что хвалит он Кукушку.

#8 LeshaL

LeshaL

    Гуру

  • Members
  • PipPipPipPipPipPip
  • 1 094 сообщений
  • ФИО:Алексей Лянгузов
  • Город:Saint-Petersburg


Отправлено 04 Март 2008 - 10:24

Доброй время суток!!

За оформления внешней документаци (Инструкции по использованию и т.д.), которая ориентирована на конецного пользователя, пишется QA командой . Так как они есть последнии люди кто прикасался к приолжению и знают работающий функционал. После этого дается на прочетения проектноной команде и нескольким постороним и собираются замечания по документации.
В крупных организациях есть выделеный человек для этих целий. Делает тоже самое.
Можно нанять фрилансера но есть риск, что будет некачественая документация (обшики, неполная т.п.), что краней не советую. Практически напише все сами он только деньги возмет. Эфекта ноль
:victory:

Про внутрению документаци молчу так зависет от процесса разработки ПО

Мое мнение, что QA команда ни в коем случае не должна писать никакую документацию для конеЦного пользователя и даже "За оформления". Она, команда, должна проверять, что то, что в этой документации написано, как минимум, написано верно.
"Беда, коль пироги начнет печи сапожник, А сапоги тачать пирожник" (с) Крылов И.
  • 0
Regards,
Alexey

#9 paper_bag

paper_bag

    Новый участник

  • Members
  • Pip
  • 1 сообщений
  • ФИО:Солпина Яна Владимировна

Отправлено 28 Апрель 2009 - 14:35

Внутреняя документация - аналитик, техпис
Внешняя - техпис. QA комментирует и проверяет.
  • 0

#10 Chosen1

Chosen1

    Новый участник

  • Members
  • Pip
  • 2 сообщений
  • ФИО:Журавлев Алексей Евгеньевич

Отправлено 10 Июль 2009 - 12:59

У нас менеджеры проектов все сами пишут:) Только основные технические моменты готовят разработчики. Для небольшой компании вполне приемлемо.
  • 0

#11 Фрося

Фрося

    Специалист

  • Members
  • PipPipPipPipPip
  • 514 сообщений
  • ФИО:Радилова Елена Игоревна

Отправлено 15 Июль 2009 - 06:45

При необходимости - руководство сажает за писанину все подряд.
В этом году была попытка выделить техписа.
В общем - я взялась.
С сентября прошлого года.
Пакет документов для сертификации ПО (начиная от планов , требований к ПО, описания проекта до итогового заключения...). Сделала. Месяца за 4.
Потом - тоже самое для новых релизов.
Параллельно - работа по текущему софту....мм... вплоть до работы в эксплуатации

В общем - проблем с техписом (и технической документацией) не будет, если :
1. В компании достаточно формализованный процесс разработки ПО
2. Роли в проекте распределены.
3. Как минимум - процесс верификации - документируется во время проведения тестирования.....
Т.е. - если есть ОСНОВА, на которой техпис может создавать документы.
Если нет -- то.... в общем.... крайне сложно.

За истекшие месяцы - накопила совершенно специфический опыт.
  • 0
Почему-то по пятницам особо остро хочется быть блондинкой....




Количество пользователей, читающих эту тему: 0

0 пользователей, 0 гостей, 0 анонимных

Яндекс.Метрика
Реклама на портале