Всё для технического документирования
+7 (925) 328-76-00
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Минимизируем документацию

17.11.2017

О том, как минимизировать количество документации и почему это важно, рассказывает Том Джонсон. И хоть эта статья довольно старая (ей 8 лет), тренды, которые наметились в то время, подтвердились и актуальны по сей день. А значит, применимы и советы, данные в этом материале.


На одной из конференций по дизайну интерфейса докладчик Грант Скоусен показал такой рисунок:

 

Простота и сложность

 

И далее мы погрузились в дискуссию о минимализме. Думаю, мы все согласны с тем, что минимализм в пользовательских интерфейсах – интересный тренд, особенно учитывая успех iPod и iPhone, которые полностью сделаны в соответствии с принципами простого минималистичного дизайна.

Грант сказал, что каждый раз добавляя что-то в интерфейс, вы должны убрать что-то другое. Соблюдая простоту интерфейса, вы можете быть уверены в том, что вы не перегружаете экранное пространство. Затем он процитировал Elder M. Russell Ballard, который сказал:

Обновить – не обязательно значит усложнить, очень часто это означает упростить.

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

Я спросил у Гранта, применимы ли принципы минимализма в области дизайна интерфейса к документации. Не сомневаюсь, вы слышали о том, что не обязательно документировать всё подряд.

Грант не был уверен, так ли это. И всё же минимализм в документации имеет тот же эффект, что и минимализм в разработке. Удаление излишнего текста, ненужных диаграмм и видео о редких случаях снижает количество «воды» в контенте. Ваши читатели фокусируются на ключевых моментах в справке, которые действительно важны и которые вы хотите, чтобы они точно прочитали.

Всегда ли меньше значит больше? Не уверен. Но раз минимализм Apple является хоть каким-то индикатором трендов, то стоит обратить внимание на минимализм в документации. Ниже – пять идей, как минимизировать документацию.

1. Делайте интерфейс проще.

Если вы можете исправить сбивающий с толку дизайн интерфейса или ход работы, вы можете снизить потребность в бесконечных инструкциях. Это идеальное решение, чтобы минимизировать документацию, но оно требует от вас вовлечения в стадию разработки на самом раннем этапе, на стадии разработки прототипа. Иногда вам нужно представить вашу идею как адвокату, приводя факты из обратной связи от пользователей и метрики, чтобы убедить менеджеров проекта и разработчиков изменить прототипы.

2. Создавайте справку контекстно зависимой.

Если вы можете предоставить пользователю справку для конкретной страницы или задачи, чтобы она была под рукой, пользователю будет казаться, что он сталкивается с меньшим количеством документации, чем есть на самом деле. Это может и не снизить реальное количество текста, которое вы пишете. И даже может увеличить. Но с точки зрения пользователя, ему не надо рыться в длинных оглавлениях и искать нужный топик. По сути, справка для него будет состоять из одной страницы, находящейся прямо здесь (а это как раз минималистично).

3. Предоставляйте пользователям краткое руководство.

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

4. Используйте топики и пункты повторно.

Если вы повторно используете один и тот же материал для нескольких руководств, это уменьшит количество документации, которую вам нужно написать. Особенно если вы пишете руководства к нескольким разным версиям одного и того же продукта, или гайды, разделённые по ролям для разных групп людей, или переводите ваш документ на несколько языков – чем больше пунктов, кусков данных и топиков вы можете повторно использовать, тем с меньшим объёмом документации вам придётся управляться.

5. Добавляйте пункты в документацию, когда пользователи запрашивают информацию.

Не впадайте в крайность, что каждый сценарий, проблема или возможное использование приложения требует документации. Если вы поставите себе такую задачу, то напишите сотни топиков, что будет избыточно для относительно простого приложения. Вместо этого отвяжите контент справки от приложения, и тогда вы сможете вносить изменения на лету. Мониторьте данные из техподдержки, анализируйте метрики и слушайте другую обратную связь от пользователей. Когда пользователи задают вопросы, не включённые в справку, добавьте в неё топик. Это модель «живой документации». Документация вырастает только до необходимых размеров, но не больше.

Заключение

Минимализм в документации – растущий тренд. А какие стратегии вы применяете для минимизирования документации?

Источник: Minimizing Documentation

 

Тэги: , , , , ,

< Вернуться к списку публикаций

Облако тегов