| Предыдущая версия справа и слева
Предыдущая версия
Следующая версия
|
Предыдущая версия
|
ru:slackdocs:styleguide [2012/10/03 10:36 (UTC)]
bormant [Общие замечания по стилю] |
ru:slackdocs:styleguide [2012/10/07 06:51 (UTC)]
bormant [Правило политики] |
| ==== Обзор ==== | ==== Обзор ==== |
| |
| Вики Slackware Documentation Project не будет стопроцентно открытой вики. Несмотря но то, что любой может внести вклад, во избежание войн правок и прочих нездоровых явлений, присущих открытым вики, проверка персоналом предоставленного материала и существенных правок будет стандартной процедурой. | Вики Slackware Documentation Project не будет стопроцентно открытой вики. Несмотря но то, что любой может поучаствовать, проверка персоналом предоставленного материала и существенных правок будет стандартной процедурой во избежание войн правок и прочих нездоровых явлений, присущих открытым вики. |
| Вкладчик будет владеть предоставленным материалом в разумных пределелах и вправе полагать, что структура и содержание статьи не будут изменены без его ведома и обсуждения корректуры на странице обсуждения. | Вкладчик будет владеть предоставленным материалом в разумных пределах и вправе полагать, что структура и содержание статьи не будут изменены без его ведома и обсуждения корректуры на странице обсуждения. |
| Персонал полагает, что такая политика будет способствовать созданию благоприятной атмосферы для позитивного и конструктивного собирания сведений на этой вики. | Персонал полагает, что такая политика будет способствовать созданию благоприятной атмосферы для позитивного и конструктивного собирания сведений на этой вики. |
| ---- | ---- |
| |
| |
| ==== Правило политики ==== | ==== Правило политики ==== |
| - Автор через страницу обсуждения выдал явное разрешение на свободное изменение/улучшение. | - Автор через страницу обсуждения выдал явное разрешение на свободное изменение/улучшение. |
| - Автор неизвестен или больше не принимает активного участия в проекте. | - Автор неизвестен или больше не принимает активного участия в проекте. |
| - Необходимо редактирование или откат действий вандалов. | - Необходимы редактирование или откат действий вандалов. |
| - Небольшие изменения по исправлению грамматики, пунктуации, орфографии, форматирования вики или внесения ясности. | - Небольшие изменения по исправлению грамматики, пунктуации, орфографии, форматирования вики или внесения ясности. |
| - Необходимо редактирования для исправления очевидно неверной информации. | - Необходимо редактирование для исправления очевидно неверной информации. |
| |
| <note>Для **исключения 6** редактором вики в статье должно быть помещено примечание-предупреждение о том, что приведённая в статье информация не соответствует действительности и будет вскоре исправлена (как только у разместившего статью появится время для ответа).</note> | <note>Для **исключения 6** редактором вики в статье должно быть помещено примечание-предупреждение о том, что приведённая в статье информация не соответствует действительности и будет вскоре исправлена (как только у разместившего статью появится время для ответа).</note> |
| |
| Это вики, и определённый уровень неформальности приемлем. Сюда относятся, например, разговорные сокращения вроде "you've". Читатель должен почувствовать, что беседует с хорошо осведомлённым другом, а не читает руководство. Тем не менее, следует избегать любого проявления небрежности. | Это вики, и определённый уровень неформальности приемлем. Сюда относятся, например, разговорные сокращения вроде "you've". Читатель должен почувствовать, что беседует с хорошо осведомлённым другом, а не читает руководство. Тем не менее, следует избегать любого проявления небрежности. |
| * Не используйте [[wpru>сленг]] или "[[wp>SMS_language|язык СМС]]". | * Не используйте [[wpru>сленг]] или «[[wp>SMS_language|язык СМС]]». |
| * Используйте полные предложения и постарайтесь избегать грамматических ошибок. Если английский не является родным языком вы всегда можете получить помощь от англоязычного редактора. | * Используйте полные предложения и постарайтесь избегать грамматических ошибок. Если английский не является родным языком, вы всегда можете рассчитывать на помощь от англоязычного редактора. |
| * Следуйте [[http://www.writersblock.ca/tips/monthtip/tipmar98.htm|правилам использования заглавных букв]] в названиях и заголовках. | * Следуйте [[http://www.writersblock.ca/tips/monthtip/tipmar98.htm|правилам использования заглавных букв]] в названиях и заголовках. |
| * Длинные пассажи голого текста трудно читать; рассмотрите возможность выразить желаемое при помощи форматированных списков. Используйте нумерованные списки только для последовательных операций, а маркированные списки --- для вариантов и примеров (как показано здесь). Иногда может быть полезна таблица или схема. | * Длинные пассажи голого текста трудно читать; рассмотрите возможность выразить желаемое при помощи форматированных списков. Используйте нумерованные списки только для последовательных операций, а маркированные списки --- для вариантов и примеров (как показано здесь). Иногда может быть полезна таблица или схема. |
| * При цитировании вывода компьютера, приводите его буквально, включая написание (как правило, американское). Для удобочитаемости заключайте такой вывод в метки %%<code></code>%%. | * При цитировании вывода компьютера, приводите его буквально, включая написание (как правило, американское). Для удобочитаемости заключайте такой вывод в метки %%<code></code>%%. |
| * Для визуального выделения в примерах, содержащих нажатия клавиш, используйте разметку %%<key></key>%%. <key>Alt-F2</key> выглядит лучше, чем "''Alt-F2''". | * Для визуального выделения в примерах, содержащих нажатия клавиш, используйте разметку %%<key></key>%%. <key>Alt-F2</key> выглядит лучше, чем «''Alt-F2''». |
| * Избегайте страдательного залога. Используйте его только когда альтернативы неуклюжи. | * Избегайте страдательного залога. Используйте его только когда альтернативы неуклюжи. |
| * Старайтесь избегать чрезмерного многословия. "Для x используйте опцию -y" или "Чтобы сделать x, наберите [[http://www.techopedia.com/definition/7264/foo|foo]] -y" читается лучше, чем "Если вы хотите, чтобы команда foo выполнила для вас x, вам нужно набрать foo -y". | * Старайтесь избегать чрезмерного многословия. "Для x используйте опцию -y" или "Чтобы сделать x, наберите [[http://www.techopedia.com/definition/7264/foo|foo]] -y" читается лучше, чем "Если вы хотите, чтобы команда foo выполнила для вас x, вам нужно набрать foo -y". |
| |
| |
| ===== Перевод страниц ===== | ===== Перевод страниц ===== |
| |
| Если полагаете, что страница вики (написанная вами или кем-либо ещё) требует внимания администраторов, добавьте на страницу метку (tag) "needs_attention". Такие страницы отображаются в списке «[[tag:needs_attention|требующих внимания страниц]]». Администраторы регулярно проверяют его на наличие новых записей. | Если полагаете, что страница вики (написанная вами или кем-либо ещё) требует внимания администраторов, добавьте на страницу метку (tag) "needs_attention". Такие страницы отображаются в списке «[[tag:needs_attention|требующих внимания страниц]]». Администраторы регулярно проверяют его на наличие новых записей. |
| |
| Когда нужно этим воспользоваться? Например, если обнаружите неполный или плохо написанный текст, или даже пустую страницу (такое возможно, если кто-то пишет текст не на английском, но не принял мер к размещению перевода на английский язык). Или, возможно, обнаружите спам или оскорбления. \\ Ваши замечания помогут нам поддерживать опрятность и высокое качество вики. | Когда нужно этим воспользоваться? Например, если обнаружите неполный или плохо написанный текст, или даже пустую страницу (такое возможно, когда кто-то пишет текст не на английском, но не принял мер к размещению перевода на английский язык). Или, может быть, обнаружите спам или оскорбления. \\ Ваши замечания помогут нам поддерживать опрятность и высокое качество вики. |
| ===== См. также ===== | ===== См. также ===== |
| |
