Каким образом плохая документация может стоить вам вашего бренда и вашей компании
Как известно, разработка документации часто является последним рывком, завершающим усилия в работе над выпуском продукта и передаче заказчику. Поскольку написание документации является последним пунктом в длинном списке требований к выпуску версии продукта, ему часто посвящают недостаточно времени и сил или совсем не принимают его во внимание.
По сути, во многих компаниях уклонение от разработки проектной и отчетной документации считают приемлемым способом минимизации затраченного времени и бюджета. Бытует мнение, что документация является лишь дополнением к продукту, дополнительной услугой, предоставляемой заказчику, но не важной составляющей частью самого продукта.
Однако заказчик видит продукт без документации по-другому
Любой продукт, кроме простейших вещей, не пригоден для использования без документации. Поставку продукта без документации можно сравнить с вываливанием на заказчика кучи деталей от ИКЕА без инструкции по сборке. Заказчик будет озадачен и недоволен, ведь он заплатил деньги за продукт, но получил его в не пригодном для использования и даже, возможно, опасном виде.
Для заказчиков продукт не является завершенным без сопровождающей документации.
Как вы видите продукт |
Как заказчик видит продукт |
Мнение, что никто не читает документацию, является ошибочным. На самом деле каждый пользователь обратится к документации, если нуждается в помощи. Если пользователь не сможет легко и быстро найти ответ в документации, он:
- ОГОРЧИТСЯ И ИСПЫТАЕТ РАЗДРАЖЕНИЕ;
- ПОЗВОНИТ В СЛУЖБУ ТЕХПОДДЕРЖКИ, ЧТО БУДЕТ СТОИТЬ ВАМ ДЕНЕГ.
Во многих случаях устаревшая документация гораздо хуже, чем отсутствие документации в целом. Когда пользователь читает документацию, он искренне убежден в том, что в ней все написано правильно настолько, насколько возможно.
Единственный возможный путь представления устаревшей документации — это громко и честно сообщать, что она фактически не обновлялась. Далее можно только просить о снисхождении, поскольку в наши дни это неприемлемо.
Что именно в документации устарело? Если какие-то фрагменты документации некорректны, но неизвестно какие, как можно доверять такой документации в целом?
Следует помнить, что ошибки в документации часто воспринимаются пользователями как ошибки в самом продукте, поскольку они ожидают, что продукт будет работать так, как написано в документации, а если не так, то значит, он работает неправильно. Если документация, к которой обращаются за помощью, написана некачественно, как доверять такому продукту? Как в таком случае доверять компании в целом? Подобные вопросы накапливаются как снежный ком и ведут к абсолютной потере доверия.
В наш век Web 2.0 люди не будут просто сидеть и злиться. Они напишут в Твиттер, Фейсбук, в другие социальные сети, где могут поделиться c миром своим гневом.
Цена документации |
Поэтому в интересах всех пользователей вашего продукта выделите дополнительное время и бюджет для написания и обновления документации. Внесите эти расходы в стоимость продукта, поскольку продукт без документации не является завершенным.
Оригинал статьи: http://www.writingassist.com/resources/articles/out-of-date-documentation/ (How out-of-date documentation can cost you your brand and your company By Jacquie Samuels)
Перевод с английского: ведущий консультант Doссо Анна Пономарева