Как провести проверку понимания пользовательской документации?

Question

[AndreiYemelianov]

Как осуществляется в вашей компании проверка пользовательской документации к программному продукту? Кто занимается проверкой? Какие критерии учитываются при такой проверке? Как вы убеждаетесь в том, что документация понятно тому, для кого она, собственно, и предназначена — конечному пользователю?

Буду благодарен за интересные материалы по теме, а также за поучительные истории из практики.

Answer 1

[Funcraft]

У нас довольно просто всё делается:

1. Документацию проверяет тот, кто её запросил. Как правило, это менеджер проекта, либо сотрудник из отдела поддержки и внедрения.

2. И, конечно, после предоставления документации конечному пользователю, собираем фидбек, по которому также вносятся поправки.

Критерии — на самом деле вопрос не однозначный, т.к. для разного рода документации, в приоритете различные критерии и факторы. В общем случае, конечно, орфография, пунктуация и прочие правила языка (включая логическое построение предложений), правильность использования терминологии, последовательность и структурность. Как-то так. Если есть вопросы по сказанному, спрашивайте — постараюсь ответить.

Comments

[AndreiYemelianov]

Спасибо!

Тогда ряд дополнительных вопросов:

1) кто у вас пишет документацию? технический писатель или кто-то из разработчиков?
2) для проверки грамматики, орфографии и стилистики у вас есть в штате редактор? или же этим занимаются менеджеры проектов/специалисты из команды разработчиков?
3) как вы собираете фидбэк от пользователей? (вот это на самом деле больше всего интересует)

[Funcraft]

1. Пишет технический писатель. Частично, разработчики (но мало).
2. Менеджер проекта + спецы поддержки.
3.1. Тут на самом деле всё очень просто у нас: есть форма обратной связи, используя которую пользователи присылают замечания и предложения как по всему продукту, так и по документации.
3.2. Точно не уверен (надо бы уточнить), но вроде спецы поддержки иногда проводят опрос случайной выборки пользователей.

p.s. Кстати, вспомнил проект orphus.ru/ — его, думаю, тоже можно использовать для сбора фидбека по докам.