Правда ≠ не ложь

Перед списком ленивый писатель пишет:

Чтобы включить гипердрайв, сделайте следующее:

  • перейдите в панель управления,
  • переведите тумблер «Гипердрайв» в положение «Вкл.»,
  • поверните пусковой ключ по часовой стрелке на 90°.

Не ленитесь! Пишите конкретно, что́ следует дальше. «Три шага», «новые модели», «наши клиенты» — всё лучше, чем «следующее».

«Следующее» ничего не значит, но как будто подходит ко всему. Это аморф, как «объект» или «человек».

Программисты любят слово «объект». Если программа сохраняет файлы и папки, программист скажет «программа сохраняет объекты». Это коротко и корректно, ведь и файл, и папка — это объекты.

Писать «следующее» тоже коротко и корректно. Фишка в том, что писать надо не корректно, а информативно.

Корректное не противоречит фактам.

Информативное предъявляет факт.

Хороший писатель не просто не лжёт. Он предъявляет правду.

P.S. Писать по-английски «the following» — такой же унылый формализм.

 
6
Kudos
 
6
Kudos

Now read this

Multi-Language Documentation in Reverse

Note: This is a longer version of my lighting talk and Write the Docs EU 2014. Delivering content in many languages is great. It’s also quite resource consuming. So, you have to decide what really needs multi-language support and what... Continue →