x
 
Игорь Селивёрстов
11 августа 2013

Максим, какими правилами руководствоваться при составлении текста справочной статьи?

Я пишу документацию для программы, и у меня ощущение, что информационный стиль делает текст менее читаемым.



Если кажется, что текст стал менее читаемым, смотрите на синтаксис.

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

  • fullscreen() включает полноэкранный режим
  • slide-once() отключает повторное скольжение
  • freeze() фиксирует объект на экране

Если описываете возможности, начинайте с них.

  • Полноэкранный режим — fullscreen(true)
  • Отключить повторное скольжение — slide-once(true), включить — slide-once(false)
  • Зафиксировать объект — freeze(#id)

Не забудьте примеры.

Подлежащее и сказуемое волшебным образом наводит порядок в предложении.

НетДа
При наличии аргументов в render-in-id() фотографии в «Альпаке» будут выводиться на странице качестве фоновых изображений указанного блочного элемента.Аргумент render-in-id() говорит «Альпаке», на фоне какого блочного элемента выводить фотографию.
Для корректной установки «Альбатросу» необходимо получить доступ к базе данных.Во время установки «Альбатрос» попросит доступ к базе данных.
Доступ администратора к серверу осуществляется через зашифрованный радиоканал.Администратор подключается к серверу через зашифрованный радиоканал.
P. S.
Это был воскресный совет о тексте, редактуре и информационном стиле. Присылайте вопросы.
Текст и редактура — дисциплина Школы редакторов. Набор открыт. Чем раньше поступите, тем ниже стоимость и выше шанс на бесплатное место.
 

Поделиться
Отправить

Цель рубрики — обсуждение вопросов дизайна всех видов, текста в дизайне и взаимоотношений дизайнеров с клиентами.

Мы публикуем комментарии, которые добавляют к уже сказанному новые мысли и хорошие примеры. Мы ожидаем, что такие комментарии составят около 20% от общего числа.

Решение о публикации принимается один раз; мы не имеем возможности комментировать или пересматривать свое решение, хотя оно может быть ошибочно. Уже опубликованные комментарии могут быть удалены через некоторое время, если без них обсуждение не становится менее ценным или интересным.

Вот такой веб 2.0.

Что лучше: развивать личный бренд в публичном поле или работать над репутацией и портфолио для рынка? Как правильно расставлять знаки препинания в предложениях, которые заканчиваются ссылкой? Есть ли сейчас смысл начинать блог, если уже есть столько других блогеров? Нужно ли вести соцсети локальным бизнесам?




Недавно всплыло

Многомерность 5 Что вы думаете о Тайпскрипте? Используете его в продуктах бюро? 2 Как быть, если арт-директор не принимает обоснованное решение дизайнера? 5 Рецепт: модуль с прокруткой содержимого и динамическим затенением по краям 1