Как писать документацию: 7 советов для начинающих технических писателей Документация — это тексты, которые объясняют, как использовать продукт. На сайте документацию публикуют в разделе «Помощь», «Help center» или «Справочник». Документация нужна, чтобы пользователь сам разобрался в продукте и решил проблемы, а не обращался к службе поддержки — так с нее снимают нагрузку. Разбираемся, как написать понятную документацию, чтобы облегчить жизнь пользователю, а не наоборот 👇🏻 1️⃣ Пишите для новичков. Даже если продуктом пользуются опытные специалисты, разжевывайте каждое понятие и действие. Например, вы пишете документацию для сервиса-редактора фотографий. Даже если редактором будут, в основном, пользоваться блогеры и фотографы с опытом, объясняйте все как маме, которая впервые держит в руках смартфон и открывает приложение. Документацию нельзя написать «слишком просто». 2️⃣ Не повторяйтесь. Упрощать не значит объяснять по несколько раз. Если вы уже описали функцию в другом разделе, дайте гиперссылку на эту страницу. 3️⃣ Разбавляйте текст фото, видео и гифками. Особенно, если описываете пошаговые действия. Например: 1. Нажмите «Редактировать». 2. Откройте вкладку «Пресеты». Выберите тот, что нравится больше и нажмите на него. 3. С помощью ползунков отрегулируйте насыщенность. Если оставите только текст, читателю придется открывать в одной вкладке инструкцию, а в другой приложение, и после каждого шага переключать вкладки. Так что добавьте ниже запись экрана, где видно каждое действие. В пошаговых инструкциях гифки для читателя удобнее — не нужно включать звук для видео или листать несколько одинаковых фотографий подряд. Чтобы сделать гифку, скачайте любой бесплатный сервис. Например, ScreenToGif. В приложении можно выделить область экрана, записать действия и сохранить их в формате .gif. 4️⃣ Используйте одни и те же термины. Не бойтесь тавтологии в документации, не перефразируйте одно и то же разными словами. Если написали «нажмите», не меняйте на «кликните», когда описываете одно и то же действие. Если назвали «вкладкой», то не меняйте на «раздел». Обычно правильное название терминов описывают в редполитике или словаре компании. Если термины нигде не зафиксировали, предложите это сделать и составьте документ с объяснением каждого понятия. Так тексты получатся консистентными и понятными для пользователей. 5️⃣ Выбирайте однозначные слова. Если описать действие или состояние можно несколькими синонимами, выбирайте то слово, у которого меньше значений. Например, у слова «вкладка» в Викисловаре два значения, а у слова «раздел» — четыре. Если в вашем контексте слова — синонимы, то выбирайте «вкладку». 6️⃣ Располагайте пункты в логическом порядке. Например, Google Docs сначала описывают, как пользоваться приложением, потом как просматривать и скачивать файлы, а потом — как ими делиться. Начинайте с базовых элементов продукта и того, что пользователь видит в первую очередь. 7️⃣ Подробнее описывайте уникальные функции. Например, в большинстве фоторедакторов для смартфона есть фильтры. Поэтому, хоть вы и описываете приложение как для новичков, многие увидят знакомое слово и интерфейс, и разберутся интуитивно. А вот если в редактор добавили функцию с непривычным названием «Раздельное тонирование», нужно подробнее объяснять ее действие — на примерах и с помощью сравнений. #сборниксоветов