28-mar-2016: Welcome to our new server! Faster and less prone to crashing.

Welcome to the Slackware Documentation Project

Руководство по стилю публикуемых на SlackDocs статей

При редактировании страниц этой вики следует иметь в виду несколько основных правил.

Политика редактрования

Обзор

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


Правило политики

Значительные 1) изменения не могут производиться без уведомления вкладчика и обсуждения.

Протокол беседы между вкладчиком и редактором должен присутствовать на странице обсуждения.

Исключения из этого правила

  1. Основные документы в пространстве имён slackware, slackdocs or slackbook, поскольку они требуют более пристального внимания редакторов.
  2. Автор через страницу обсуждения выдал явное разрешение на свободное изменение/улучшение.
  3. Автор неизвестен или больше не принимает активного участия в проекте.
  4. Необходимы редактирование или откат действий вандалов.
  5. Небольшие изменения по исправлению грамматики, пунктуации, орфографии, форматирования вики или внесения ясности.
  6. Необходимо редактирование для исправления очевидно неверной информации.

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


Примечание

Основное пространство имён slackware, slackdocs и slackbook является сердцем этого проекта. Хотя статьи HOWTO и прочие разделы вики для проекта тоже важны, основная документация — вот главная цель наших усилий в проекте. С учётом сказанного, персонал полагает, что содержимое указанных разделов должно скрупулезнее редактироваться и поддерживаться. Более строгий надзор за основными разделами по достоинству оценят и те, кто использует данный ресурс для самообучения, продолжая использовать Slackware Linux.

Спасибо за понимание и сотрудничество в этом деле.

Этикет при редактировании

Снимайте блокировку

При щелчке на кнопке «править страницу» включается «режим редактирования». В этом режиме страница или раздел блокируется для предотвращения её одновременного редактирования кем-либо ещё (создание конфликта). Если закрыть окно браузера находясь в режиме редактирования, блокировка страницы не будет снята ещё 15 минут. Решив не изменять странцу, выходите из редактора нажатием кнопки «Отменить». Это снимет блокировку и точас же позволит другим править страницу.

Редактируйте раздел, а не страницу целиком

Справа от каждого заголовка раздела страницы расположена ссылка [править]. Если для редактирования раздела щелкнуть по ней, то будет заблокирован только этот раздел, что позволит другим редактировать прочие разделы страницы. Этот способ рекомендован при переводе страниц, исправлении опечаток или нескольких предложений/слов.

Добавляйте сводку изменений

В режиме редактирования следом за кнопками Сохранить/Просмотр/Отменить расположено поле ввода «Сводка изменений». В нескольких словах поясните внесённые изменения. Этот комментарий будет отображаться на вкладке «История страницы», а также в обзоре недавних изменений.

Небольшие изменения

Когда исправляете ошибку, изменяете слово или глобально проводите небольшие изменения, отметьте флажок «Небольшие изменения» справа от поля «Сводка изменений». Dokuwiki позволяет отслеживать изменения через RSS. «Небольшие изменения» не влекут обновления ленты RSS.
На вкладке «история страницы» небольшие изменения будут упомянуты.

Добавляйте "подвал"

Каждая страницу следует завершать подобным кодом вики, особенно, если текст скопирован из внешнего источника:

===== Источники =====

  * основной автор
  * контрибуторы

{{tag>список меток}}

Примечание о "примечаниях"

Возможно различное оформление примечаний:

Примечание

Совет

Важно

Предупреждение

Это результат использования:

<note>Примечание</note>
<note tip>Совет</note>
<note important>Важно</note>
<note warning>Предупреждение</note>

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

Общие замечания по стилю

Это вики, и определённый уровень неформальности приемлем. Сюда относятся, например, разговорные сокращения вроде «you've». Читатель должен почувствовать, что беседует с хорошо осведомлённым другом, а не читает руководство. Тем не менее, следует избегать любого проявления небрежности.

  • Не используйте сленг или «язык СМС».
  • Используйте полные предложения и постарайтесь избегать грамматических ошибок. Если английский не является родным языком, вы всегда можете рассчитывать на помощь от англоязычного редактора.
  • Следуйте правилам использования заглавных букв в названиях и заголовках.
  • Длинные пассажи голого текста трудно читать; рассмотрите возможность выразить желаемое при помощи форматированных списков. Используйте нумерованные списки только для последовательных операций, а маркированные списки — для вариантов и примеров (как показано здесь). Иногда может быть полезна таблица или схема.
  • При цитировании вывода компьютера, приводите его буквально, включая написание (как правило, американское). Для удобочитаемости заключайте такой вывод в метки <code></code>.
  • Для визуального выделения в примерах, содержащих нажатия клавиш, используйте разметку <key></key>. Alt+F2 выглядит лучше, чем «Alt-F2».
  • Избегайте страдательного залога. Используйте его только когда альтернативы неуклюжи.
  • Старайтесь избегать чрезмерного многословия. «Для x используйте опцию -y» или «Чтобы сделать x, наберите foo -y» читается лучше, чем «Если вы хотите, чтобы команда foo выполнила для вас x, вам нужно набрать foo -y».

Перевод страниц

Мультиязычные возможности этой вики требуют соблюдения некоторых правил. О них читайте в отдельном Руководстве по переводу.

Страницы, требующие внимания администратора

Если полагаете, что страница вики (написанная вами или кем-либо ещё) требует внимания администраторов, добавьте на страницу метку (tag) «needs_attention». Такие страницы отображаются в списке «требующих внимания страниц». Администраторы регулярно проверяют его на наличие новых записей.

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

См. также

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

На других языках
Перевод этой страницы?:
QR Code
QR Code ru:slackdocs:styleguide (generated for current page)