Следующая версия | Предыдущая версияСледующая версияСледующая версия справа и слева |
ru:slackdocs:styleguide [2012/10/02 15:48 (UTC)] – translated to Russian bormant | ru:slackdocs:styleguide [2012/10/03 10:55 (UTC)] – [Страницы, требующие внимания администратора] bormant |
---|
====== Руководство по стилю статей, публикуемых на SlackDocs ====== | ====== Руководство по стилю публикуемых на SlackDocs статей ====== |
| |
При редактировании страниц этой вики следует иметь в виду несколько основных правил. | При редактировании страниц этой вики следует иметь в виду несколько основных правил. |
| |
| |
===== Политика редактрования ===== | ===== Политика редактрования ===== |
| |
Это вики, и определённый уровень неформальности приемлем. Сюда относятся, например, разговорные сокращения вроде "you've". Читатель должен почувствовать, что беседует с хорошо осведомлённым другом, а не читает руководство. Тем не менее, следует избегать любого проявления небрежности. | Это вики, и определённый уровень неформальности приемлем. Сюда относятся, например, разговорные сокращения вроде "you've". Читатель должен почувствовать, что беседует с хорошо осведомлённым другом, а не читает руководство. Тем не менее, следует избегать любого проявления небрежности. |
* Не используйте [[http://ru.wikipedia.org/wiki/сленг|сленг]] или "[[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|требующих внимания страниц]]». Администраторы регулярно проверяют его на наличие новых записей. |
| |
Когда нужно этим воспользоваться? Например, если обнаружите неполный или плохо написанный текст, или даже пустую страницу (такое возможно, если кто-то пишет текст не на английском, но не принял мер к размещению перевода на английский язык). Или, возможно, обнаружите спам или оскорбления. \\ Ваши замечания помогут нам поддерживать опрятность и высокое качество вики. | |
| |
| Когда нужно этим воспользоваться? Например, если обнаружите неполный или плохо написанный текст, или даже пустую страницу (такое возможно, если кто-то пишет текст не на английском, но не принял мер к размещению перевода на английский язык). Или, может быть, обнаружите спам или оскорбления. \\ Ваши замечания помогут нам поддерживать опрятность и высокое качество вики. |
===== См. также ===== | ===== См. также ===== |
| |