Comments 5
... не полна ... не точна ... не актуальна ...
Увы, но даже полная, точная и актуальная документация может "не очень хорошо выполнять свою задачу". У меня вот есть Руководство Пользователя, которое вроде бы полное, точное и актуальное (при добавлении любой фичи в программу она одновременно документируется в Руководстве). А задача не выполняется, так как найти ответ на нужный вопрос пользователи все равно очень часто не могут. Хотя вроде бы и структура Руководства довольно логичная, и поиск работает, и внутренние связи настроены (везде гипертекст). Но вот сформулировать правильно вопрос, чтобы было понятно - где именно искать ответ - это очень часто проблема. Как сделать, чтобы документация не только давала ответы на правильно сформулированные вопросы, но и подсказывала, как задать вопрос? Я вот не знаю. Хорошо, что пользователей у нас не так много, и в случае чего можно просто написать авторам проги. (А я в ответ обычно пишу пару фраз плюс даю ссылку на раздел справки). А как быть, когда продукт массовый?
> Увы, но даже полная, точная и актуальная документация
Просто в данном случае она не "полная". Полное точное и актуальное тут только Руководство.
А самой документации должно быть больше, нацеленной на разное использование. Вот https://habr.com/ru/company/timeweb/blog/562408/ перевод сответствущей статьи есть.
как задать вопрос?
А тут нужна обратная связь от пользователей. В моём случае помогает общение с тех.поддержкой, и большая часть предложений по улучшению и дополнению как документации, так и статей базы знаний приходит именно от них. То есть появляются более-менее похожие тикеты, значит, тема либо не освещена, либо освещена не теми фразами и она не находится на вебах (поисковики свою работу сделали, проиндексировали, а фразы не те, что используются при поиске).
Благодаря такому двухстороннему общению появляются актуальные (за это отвечает мой отдел тех.писателей, следя постоянно за обновлением решений), так и полезные (о чём рапортует тех.поддержка) мануалы.
А статьи базы знаний у нас - это отдельная сущность, которая раскрывает некоторые кейсы по использованию решений. То есть в документации - что может продукт и какие предоставляет настройки с некоторыми простыми примерами, в статьях - уже более сложные примеры кейсов, для чего могут понадобиться те или иные настройки.
задача не выполняется, так как найти ответ на нужный вопрос пользователи все равно очень часто не могут
А как вы узнали, что пользователи не могут найти ответ на нужный вопрос? Я представляю диалог:
Пользователь: не могу найти ответ на свой вопрос!
Разработчик: какой вопрос?
Пользователь: эээ, ой всё
сформулировать правильно вопрос - это проблема
Какой смысл вообще иметь документацию, если ваши пользователи не могут сформулировать вопрос?
Или всё же пользователи могут сформулировать вопросы, но вам пофиг?
Я почему тут задаю глупые вопросы. Я хоть и разработчик, но иногда пользователь чужих продуктов. И я умею задавать вопросы и искать информацию. Может быть часть пользователей такие как я? А для другой части пользователей надо иметь другой подход? Или все-все пользователи "ну тупыеее"?
Вам кажется, что с вашей документацией что-то не так? Вам не кажется