Как писать статьи для сайта

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

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

Рекомендации по содержанию

1. Пишите инструкцию, а не историю

Когда вы пишете статью для сайта, основная задача — не рассказать то, что вы сделали и что из этого у вас получилось, а научить пользователя, который будет читать вашу статью, делать то же самое. Когда люди читают техническую статью о том, как разогнать процессор, видеокарту или как установить ту или иную программу, им не очень интересно узнать как это делал кто-то, им нужна пошаговая инструкция о том, как они сами будут это делать. Если это инструкция, то не надо писать «Я сделал это», «Мы установим такое значение». Пишите «Сделайте то-то», «Установите такое-то значение» и т.д..

2. Не повторяйтесь

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

3. Не используйте списки для пошаговых инструкций

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

Если вам хочется использовать список с нумерацией в инструкции, делайте это на уровне структуры. Разбейте её на шаги, каждый шаг будет отдельным подзаголовком. Так будет намного лучше и для пользователя и для поисковых систем. Например как это сделано в моей статье об установке Ubuntu 18.04.

4. Используйте оригинальные названия программ

Существуют различные операционные системы — Windows, Linux и др., есть компании Microsoft, Gigabyte, AMD и др., есть продукция этих компаний. У всего этого есть свои названия, не надо придумывать для них новые. Не переводите названия на русский и не пишите их прописными буквами, если только они не пишутся прописными буквами официально, например: AMD, MSI (но не GIGABYTE, потому что официально пишут Gigabyte). То же самое касается сленговых названий, например, не XPюша, а Windows XP.

5. Используйте русские единицы измерения

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

6. Не копируйте чужие материалы

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

7. Старайтесь избегать лишних слов

В русском языке есть слова, без употребления которых можно обойтись. К таким словам, например, относится слово «является». Рассмотрим пример: «Этот процессор является лучшим для геймеров«. Не надо так писать, лучше будет так: «Это лучший процессор для геймеров«. Такое предложение легче читается и воспринимается. Аналогично, не следует использовать слово «который» слишком часто в тексте. Например: «Процессор, который повторил успех своих предшественников». Лучше будет сказать: «Процессор, повторивший успех своих предшественников». Больше пользуйтесь причастиями и оборотами. Возьмите за правило отдельно проверять текст перед публикацией на наличие слов, подобных слову «который», и заменять выражения с ними по возможности на более звучные.

8. Не используйте несуществующих слов и терминов

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

9. Тщательно проверяйте информацию

Проверяйте информацию, добавляемую в свою статью, не надо придумывать что-то от себя. Берите данные из надёжных источников. Особенно это касается характеристик процессоров, материнских плат и другого оборудования. Есть сайты, которым можно доверять. Это официальные сайты производителей оборудования, а также порталы CNET, CPU-World, MotherboardDB. Не надо выискивать важные для статьи параметры на форумах и уж точно не надо придумывать их самому.

10. Пишите «Вы» с маленькой буквы

Согласно правилам, слово «Вы» начинается с прописной буквы только в случае обращения в тексте к какому-то конкретному лицу. Если же автор обращается к абстрактному читателю или к аудитории, слово «вы» пишется начинаясь со строчной буквы.

11. Не переводите английские аббревиатуры

Когда я делал переводы инстранных статей, очень часто авторы присылали статьи с такими терминами как ЦПУ, ГПУ, ЦП и самым безобидным из них — ПК. Если к термину ОЗУ ещё все как-то привыкли, то термин ЦПУ уже очень сильно режет слух. Не надо так переводить их. Если очень надо написать английскую аббревиатуру, пишите её в оригинале или замените словом-аналогом.

12. Не игнорируйте букву «ё»

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

В редакторе MS Word можно включить автоматическую проверку использования буквы «ё». Для этого откройте меню Файл -> Параметры -> Правописание. Установите флажок Русский. Требовать точного использования ё. Теперь редактор будет подчёркивать красным слова, в которых эта буква должна быть (кроме, омографов типа «нем», «всем» и т.д.).

13. Следите за использующимися временами глаголов

Когда я ходил на курсы английского и мы писали там сочинения, у всех и у меня тоже были проблемы с временами. Первое предложение писалось в прошлом времени, а следующее уже в настоящем. Проблема характерна не только для английского. В статьях на русском авторы тоже любят устраивать путаницу с временами. Не надо прыгать из прошлого в будущее, потом в настоящее и обратно и так далее. Пишите предложения однотипно!

14. Не используйте канцеляризмов

Старайтесь избегать канцеляризмов. Например, «Мы наблюдаем понимание корпорацией ряда проблем» следует заменить на: «Налицо понимание корпорацией ряда проблем». Избегайте речевой избыточности, например: «Учащиеся школ, в которых они проходят обучение, пришли на линейки, посвящённые началу нового учебного года, чтобы вновь сесть за парты, продолжить обучение в стенах родного учебного заведения» или «Дети вновь пришли на линейки, чтобы сесть за парты в родных стенах». Стремитесь к ясности и краткости мысли!

То же самое касается метода повествования. Общайтесь с пользователем, объясните ему как что-то сделать. Часто встречается ситуация, когда авторы рассказывают о каком-то пользователе. Например: «Если пользователь хочет чтобы яркость монитора была меньше», лучше заменить на «Если вы хотите чтобы яркость монитора была меньше».

15. Придерживайтесь одного стиля

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

16. Не путайте «ТЬСЯ» и «ТСЯ»

Это часто встречающаяся проблема у авторов, в том числе и у меня. Тем не менее, писать глаголы правильно очень важно, так как неправильно употреблённые формы могут приводить к очень комичным ситуациям. Могу привести в качестве примера мою статью «Как подключиться по SSH». Когда-то я там написал «Как подключится по SSH». Туда ещё троеточие добавить и получится уже совсем иной смысл. 🙂

Проверить очень легко. Употребление зависит от контекста. Задаваемый вопрос должен соответствовать требуемому действию, а уже исходя из этого надо выбирать нужную форму глагола. Например, вопрос «Как подключится к роутеру?» написан в желательном для нас контексте неправильно. Мы спрашивали о том, как нечто сделать? Соответственно, форма глагола в данном случае: подключиться — что сделать? В оригинале же мы, ошибившись с формой глагола, спросили совершенно другое: как нечто сделает что-то? То есть, как нечто подключится к роутеру? Форме глагола «подключится» в данном контексте соответствует вопрос «Что сделает?»

17. Правильно используйте дефис и тире

Если коротко, то дефис ставится только между частями слова, между словами необходимо ставить тире. Для того, чтобы поставить тире в редакторе MS Word, можно использовать сочетание клавиш Ctrl+Alt+- (Ctrl+Alt+дефис). В это редакторе также есть автозамена дефиса на тире.

18. Один шаг — одно действие

Если вы пишите пошаговую инструкцию, с заголовками, начинающимися с «Шаг 1. ..», «Шаг 2. …» и так далее, то в одном таком шаге может находится только одно действие и каждый шаг должен иметь свой снимок экрана. Не надо сбивать два или три шага в один. Пошаговая инструкция должна быть подробной.

Рекомендации по оформлению

1. Введение должно занимать два абзаца

Это не имеет отношения к стилю, правильности, грамматике и тому подобному. Это анонс статьи, рассылаемый во все социальные сети для выполнения репоста. Кроме того, туда вставляется реклама. Воду там лить не надо, пишите по сути: о чём статья будет написана, зачем это надо, что пользователю надо знать для того, чтобы всё понять и так далее.

2. Используйте инструменты форматирования Word

Статьи сайта только лишь готовятся с использованием MS Word, LibreOffice или другого редактора. Публикуются не документы авторов, а веб-страницы, образующиеся из этих документов с помощью вёрстки. В связи с этим, не надо стараться подготовить окончательный вариант. Не надо пытаться слишком уж рьяно форматировать абзацы или делать отступы (красные строки), да ещё с помощью пробелов. Тем более не надо устанавливать интервалы между абзацами с помощью пустых строк. Не надо пытаться также сформировать конечные страницы для читателя, как это обычно делается в документах. В простых веб-документах не применяются отступы и нет разбиения на страницы. Корректор и верстальщик потратят уйму времени на удаление всех этих художеств. Давайте ценить время друг друга.

Для форматирования заголовков в Word имеются специальные кнопки стилей:

По умолчанию для текста используется стиль Обычный. Для строки с заголовком просто выберите стиль Заголовок. Вы можете изменить параметры стиля Обычный, кликнув по небольшому значку в правом нижнем углу элемента со стилями и затем выбрав пункты Обычный -> Изменить.

В свойствах стиля можно указать размер шрифта, выравнивание текста и другие параметры. Также здесь можно нажать Формат -> Абзац и настроить такие параметры абзацев, как отступы, интервалы меж абзацами, положение абзацев на странице и др.

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

Более профессиональный путь — подготовка базовых стилей и абзацев для затравки для последующего использования в каждом новом документе прямо в шаблоне Normal.dotm. Иногда это только и спасает, когда нужно быстро переформатировать документ, в котором так накурочили с форматированием, что уже никто и разобраться не может. Готовые абзацы, отформатированные лично вами в базовом шаблоне, могут быть использованы для автоматического переформатирования абзацев в чужом документе с помощью инструмента Метла (Формат по образцу). Суть его работы в применении параметров форматирования, взятых с помощью этого инструмента в одном абзаце, к другому абзацу в документе.

3. Не используйте сложные элементы форматирования

Как я уже сказал, документ будет публиковаться в формате HTML. Многое из того, что вы можете сделать в Word, нельзя делать в HTML, а если и можно, то в этом нет смысла и никто не будет этим заниматься. Поэтому не надо придумывать каких-то мудрёных многоуровневых списков, объединять ячейки в таблицах, делить документ на колонки, делать выравнивание по центру, по ширине или ещё каким либо образом и заниматься другими ненужностями. Вот основные элементы, которые вы можете использовать:

  • заголовки 1-3-го уровней;
  • выделение цветом, жирным, курсивом;
  • маркированные и нумерованные списки одного уровня;
  • картинки;
  • таблицы;
  • диаграммы;
  • спецсимволы Word (очень актуально: пишут «х» вместо «×», «градус» вместо «°» и т.д.).

4. Оформляйте списки правильно

Существуют два вида списков. К первому виду относятся списки, каждый элемент которых представляет из себя отдельное предложение. В этом случае все элементы-предложения начинаются с прописной буквы и заканчиваются знаком препинания (точка, восклицательный знак и др.). Например:

  • Откройте меню Пуск.
  • Найдите там приложение с таким-то названием.
  • Запустите приложение двойным щелчком мышки по названию.

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

Во дворе росли:

  • яблоня;
  • груша;
  • персик;
  • абрикос.

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

  • Операционная система: Arch Linux.
  • Процессор: Ryzen 3600X.
  • Видеокарта: Nvidia какая-то там.

Как я уже говорил выше, не надо путать списки с другими элементами оформления. Нельзя вставлять с список изображения или команды. В списке могут быть только элементы списка.

5. Не ставьте точки в заголовках

Я не знаю, почему всё ещё надо об этом говорить, но точки в конце заголовков не ставятся в ситуации, когда заголовок — именно название, а не предложение. Для простоты, не ставьте в своих статьях точки в заголовках вообще. Не ставьте. Можно использовать вопросительные знаки, знаки восклицания, но не точки.

6. Используйте пробелы по назначению

Не надо ставить по два пробела подряд в предложении, также не надо ставить пробел перед точкой, запятой, двоеточием и другими знаками препинания. Перед открывающей скобкой пробел ставить надо, а после неё — нет, с закрывающей скобкой — всё наоборот, перед ней пробела нет, а после есть.

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

7. Используйте выделение жирным вместо кавычек

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

8. Используйте проверку орфографии в Word

Разработчики из компании Microsoft очень хорошо проработали проверку орфографии в своём офисном пакете. Редактор MS Word находит если не все ошибки и опечатки, то очень многие, и если вы уже в нём работаете, то подсветку проблем с орфографией и пунктуацией следует использовать. Она включена по умолчанию, однако не будет работать, если для проверки орфографии в текущем выделении (иногда это весь документ) выбран неподходящий язык. Тогда красным будет подчёркнуто всё:

Выделите весь текст с помощью сочетания клавиш Ctrl+A (если не хотите возиться отдельно со словами, написанными на других языках в многоязычных текстах). Затем кликните по названию языка внизу страницы и выберите Русский.

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

Теперь все ваши ошибки будут подсвечены красным и их останется только исправить.

9. Пишите команды с новой строки

Часто в инструкциях приходится писать команды, которые пользователю надо будет выполнить в терминале Linux или командной строке Windows. Пишите такие команды в новой строке. Причём в этой строке должна находится только команда, все пояснения к ней либо выше, либо ниже. Команда выделяется особым образом на сайте, поэтому её надо выделять в документе. Выделяйте команды каким-нибудь фоном, например, серым.

Рекомендации для авторов перед сдачей статьи

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

  1. Проверьте наличие подчёркнутых слов в подготовленном тексте, исправьте ошибки.
  2. Убедитесь, что отключено сжатие изображений в Word и что изображение хорошего качества.
  3. Поищите двойные пробелы, «градусы», английские названия для единиц измерения и исправьте.
  4. Убедитесь, что все списки оформлены верно, а названия характеристик выделены жирным.
  5. Убедитесь, что все кнопки, названия пунктов меню и тому подобное выделены жирным, а не кавычками.
  6. Убедитесь, что цифры, используемые в своей статье, верны, особенно, это важно для напряжений, частот и других физических характеристик.
  7. Проверьте, употребили ли вы все ключевые слова из технического задания.

Выводы

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

Читайте также:

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *