Советы по стилю статьи, грамматике, содержанию и SEO

Не смешивайте моноширинные шрифты с пропорциональными в одном предложении. Используйте курсив для специального текста. Например, не пишите dnf install foo в середине предложения, пишите dnf install foo.

Используйте курсив для системных объектов, упоминаемых в предложении:

Используйте стиль Preformatted в редакторе WP Engine для ввода или вывода командной строки. Используйте приглашение оболочки ($ или #) только там, где оно действительно влияет на смысл, или чтобы отделить ввод от вывода. Также полезно использовать полужирный шрифт для самого ввода:

$ command arg1 arg2
output line 1
output line 2

Используйте полужирный шрифт только для крайне важной фразы или утверждения.

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

Проверяйте орфографию и грамматику. Никому не нравятся придирчивые замечания по этому поводу. Проверьте свою работу перед отправкой редактору. Редакторы: перепроверяйте всю работу, это ваша задача!

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

Избегайте страдательного залога. Страдательный залог — это использование дополнения предложения в качестве подлежащего. Например:

Остерегайтесь герундиев (слов на -ing). Они обычно указывают на страдательный залог. Перепишите предложение, чтобы сделать его сильнее. Например:

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

Избегайте чрезмерного использования глагола to be в предложениях. Чрезмерное использование is, will be или can be делает ваши предложения слабыми и вялыми. Попробуйте использовать глагольную форму слов, которые вы перенесли в другую часть предложения. Часто вы можете просто опустить слова или использовать повелительную (командную или советующую) форму предложения.

Используйте стандартный американский английский для орфографии и других международных различий. Американский английский является лингва франка для проекта Fedora в целом.

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

Не трогайте файлы, управляемые пакетами. Процессы не должны включать редактирование файлов в системных каталогах, таких как /usr или /lib*. Редактируйте /etc или пользовательскую конфигурацию в домашнем каталоге.

Предпочитайте свободное программное обеспечение там, где это практично (и официально упакованное программное обеспечение, где это возможно). Журнал может по-прежнему освещать несвободное программное обеспечение, используемое в Fedora, если мы знаем или подозреваем, что оно очень популярно и полезно для пользователей Fedora. (Google Chrome — хороший пример.) Но если ваша статья описывает общий процесс, используйте свободное программное обеспечение.

Используйте libvirt/KVM в советах, а не VirtualBox или другие гипервизоры. Часто люди, пришедшие с других платформ, имеют опыт работы с VirtualBox. Однако гипервизор KVM и libvirt в Fedora являются свободным программным обеспечением и частью платформы. Используйте их, пишите о них, любите их.

Если нет необходимости, используйте дистрибутивы семейства Fedora. Fedora Magazine продвигает Fedora. Если цель вашей статьи не состоит в том, чтобы специально объяснить междистрибутивный механизм, используйте установки, контейнеры или дистрибутивы внутри семейства (Fedora, CentOS, RHEL).

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

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

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

Используйте правильный стиль для третьих сторон. Названия компаний, проектов и технологий не всегда следуют правилам стиля типичных английских слов. Выбирайте стиль, используемый авторитетными веб-сайтами, если вы не уверены. Если авторитетные источники используют несогласованный стиль, руководствуйтесь здравым смыслом. Неисчерпывающий список:

Используйте свежую стандартную Fedora Workstation, а не ваш личный рабочий стол или конфигурацию. (Лучше всего создать виртуальную машину со свежей установкой Fedora Workstation и выполнять шаги там.) Если вы показываете что-то, что зависит от другого рабочего стола, выполните свежую установку и используйте её.

Установите разрешение экрана разумным, но не слишком высоким, например 1280x960 или 1280x800.

Если вы показываете только окно браузера, сделайте его достаточно большим на экране и сделайте снимок экрана только браузера. (Подсказка: для этого можно использовать приложение Screenshot!)

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

Загрузите и используйте этот оригинальный медиафайл в вашей статье. Если снимок большой, например большое окно браузера, приложение или весь экран, выберите миниатюру среднего размера и позвольте WP Engine выполнить преобразование.

Используйте простое, релевантное название. Предпочтительно это должен быть призыв к действию, например Build a widget using GTK+, или описание списка, например 5 fun games in Fedora. Название влияет на поисковые системы и приводит к большему количеству попаданий и более высокому рейтингу страницы. Это помогает привлекать трафик в Журнал.

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

Используйте хорошие практики SEO. Используйте предоставленный плагин SEO для максимизации поискового рейтинга статьи. Стремитесь к «зелёной» оценке в блоке Publish в правом верхнем углу экрана редактирования вашей статьи. Следуйте этим рекомендациям:

Используйте опцию Edit as HTML при вставке в блоки preformatted. Известно, что текущие версии WP Engine удаляют ведущие символы решётки (#) и ведущие пробелы при вставке содержимого в блоки preformatted. Некоторые неалфавитно-цифровые символы также могут искажаться (&, <, > и т. д.). Использование опции Edit as HTML (расположенной под вертикальным многоточием) перед вставкой содержимого в блок, похоже, обходит эту проблему. Обязательно вставляйте содержимое между тегами <pre> и не перезаписывайте их. После вставки содержимого вернитесь в визуальный режим с помощью опции Edit visually, чтобы увидеть лучшее представление того, как конечный результат будет выглядеть для читателя.