Инструменты пользователя

Инструменты сайта


Стилистика текстов

1. If then else

Если вы думаете, что в предложении с «если» непременно нужно использовать союз «то», то вы ошибаетесь.

При использовании «если-то» в коротких предложениях текст становится похож на алгоритм на Паскале. Союз «то» стоит использовать либо для разнообразия, либо если он стоит далеко от соответствующего ему «если».

По умолчанию «то» стоит опускать.

2. Скобки (если понимаете о чём я)

Скобки — знак препинания, который стоит использовать только для очень коротких (англ. very short) уточнений, которые сложно состыковать с основным текстом без его раздувания и прерывания информационного ритма (не стоит брать в скобки целое предложение: читабельность повысится, если оно будет написано просто наравне с остальным текстом (иными словами, чаще всего для улучшения достаточно скобки просто убрать)).

Не балуйтесь со скобками. Русский язык — не Lisp

3. Причастный оборот — фол последней надежды

Не стройте структурно сложные, вложенные предложения.

  • Если возможно, замените причастный оборот на сложносочинённое предложение.
  • Если возможно, замените сложносочинённое предложение на два предложения.

Сложно: На плате мы разместили возвратные светодиоды, защищающие управляющие транзисторы от обратной ЭДС, возникающей в моменты разгона и торможения двигателя.

Проще: На плате мы разместили возвратные светодиоды. Они защищают управляющие транзисторы от обратной ЭДС, которая возникает в моменты разгона и торможения двигателя.

Всему нужна своя мера. Причастные обороты хороши в коротких предложениях для создания контраста со сложным текстом, который им предшествует.

4. USB-кабели и интернетовые магазины

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

Правильно:

  • USB-кабель
  • Интернет-магазин
  • Веб-сайт

Если на первой позиции стоит прилагательное, дефис, конечно, не нужен:

  • USB’овый кабель :-x
  • Интернетовый магазин :-x
  • Вебный сайт :-x

Если англоязычная аббревиатура стоит на второй позиции, дефис также не нужен:

  • Кабель USB
  • Переходник VGA-HDMI

Отдельное внимание: «аудио-» и «видео-» — это корни многокоренных слов, поэтому дефисы между ними и вторым словом не ставятся, они пишутся слитно:

  • Аудиовыход
  • Видеовход

5. Здесь вам не тут

Не используйте в качестве текста якоря для ссылок фразы вроде «здесь», «тут», «этой страницы».

Плохо: Библиотеку для управления индикатором можно скачать тут
Хорошо: Мы специально подготовили библиотеку для управления индикатором

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

6. Не Выкайте

Местоимение «вы» пишется с маленькой буквы.

Есть редкие исключения. Но они не имеют отношения к маркетинговой деятельности компании.

7. В своём тексте и своём проекте

Всякий раз, когда вы пишете «ваш» или «вашем», задумайтесь: а нельзя ли заменить это слова на «свой», «своём». Если можно — смело заменяйте.

Не очень: Если вы хотите добавить в ваш проект управление через телефон, возьмите Bluetooth-модуль. Лучше: Если вы хотите добавить в свой проект управление через телефон, возьмите Bluetooth-модуль.

Использование «своего» вместо «вашего» изменяет восприятие текста в лучшую сторону. Читатель уже представляет объект, как свою собственность, несмотря на то, что физически он объектом ещё не обладает. Это повышает желанность объекта.

Обязательно к прочтению и вооружению

TODO

  • на плате есть vs мы предусмотрели