wiki:style [2009/04/27 11:00]
Тиль Уленшпигель |
wiki:style [2016/01/31 09:43] (текущий)
|
| - | ====== Hints on good style ====== | + | ====== Советы по стилю статьи ====== |
| | | | |
| - | Вот несколько советов как написать хорошую wiki статью. | + | Вот несколько советов к написанию хорошей wiki-статьи. |
| | | | |
| | ===== Структура статьи ===== | | ===== Структура статьи ===== |
| | | | |
| - | * Начните Вашу статью с заголовка первого уровня со значащим названием. | + | * **Начните вашу статью с заголовка первого уровня с осмысленным названием**. |
| - | * Вставляйте уровни заголовка в их правильном порядке, секции во втором уровне должны начаться с заголовка второго уровня. | + | * Вставляйте уровни заголовка в их правильном порядке, секции во втором уровне должны начинаться с заголовка второго уровня. |
| | * Разбейте свой текст на параграфы, оставляя пустую линию между ними. Средний параграф не должен быть длиннее 10-20 предложений. | | * Разбейте свой текст на параграфы, оставляя пустую линию между ними. Средний параграф не должен быть длиннее 10-20 предложений. |
| - | * Если Ваш текст длиннее (3-5) параграфов, рассмотрите деление его в [[wiki:syntax#sectioning|секции]], добавляя заголовки со второго по пятый уровни. | + | * Если ваш текст длиннее 3-5 параграфов, рассмотрите деление его в [[wiki:syntax#sectioning|секции]], добавляя заголовки со второго по пятый уровни. |
| - | * Когда Ваш текст становится длиннее чем 2-3 страницы, поместите короткое резюме содержания статьи после первого заголовка. Когда Ваша статья становится значительно длинной, рассматрите вариант разделения на сотавные статьи. | + | * Когда ваш текст становится длиннее 2-3-х страниц, рекомендуется поместить короткое резюме содержания статьи после первого заголовка. Когда ваша статья приобретает значительный объем, рассмотрите вариант её разделения на составные статьи. |
| - | * Если у Вас есть много связей с другими wiki статьями или внешними ресурсами, добавьте специальную секцию с дальнейшими ссылками (см. ниже)(see [[#references|below]]). | + | * Если у вас есть много связок (ссылок) с другими wiki-статьями или внешними ресурсами, добавьте специальную секцию с дальнейшими ссылками (см. ниже)(see [[#references|below]]). |
| - | * Если большинство статей [[:namespace]] разделяет общую структуру, добавляется [[:namespace]] шаблон, таким образом любая новая страница может начаться со скелетной структуры. | + | * Если большинство статей [[wiki:namespaces]] разделяет общую структуру, добавляется [[wiki:namespaces]] шаблон, таким образом любая новая страница может начаться со скелетной структуры. |
| | * Попытайтесь использовать короткие и легко запоминающиеся названия. | | * Попытайтесь использовать короткие и легко запоминающиеся названия. |
| | | | |
| | ===== Текстовое форматирование ===== | | ===== Текстовое форматирование ===== |
| | | | |
| - | * Выделяйте отдельные слова или словосочетания используя **жирный** или //курсив//. Выберите что-то одно и придерживайтесь своего выбора. | + | * Выделяйте отдельные важные слова или словосочетания используя **жирный** или //курсив//. Выберите что-то одно и придерживайтесь своего выбора. |
| | * Выберите стиль для того, чтобы представить изображения и текст на экране как кнопки или лейблы меню и используйте это последовательно("При создании статьи формируется ее содержание из заголовков 1-3 уровня. Необходимо иметь последовательность для удобства воспринимаемой инфы. Других объяснений данного пункта не вижу"-(с) Black Monarh). Хорошая идея добавить статью с объяснением Наших соглашений стиля к Нашей wiki. | | * Выберите стиль для того, чтобы представить изображения и текст на экране как кнопки или лейблы меню и используйте это последовательно("При создании статьи формируется ее содержание из заголовков 1-3 уровня. Необходимо иметь последовательность для удобства воспринимаемой инфы. Других объяснений данного пункта не вижу"-(с) Black Monarh). Хорошая идея добавить статью с объяснением Наших соглашений стиля к Нашей wiki. |
| - | * Используйте [[wiki:syntax#lists|незаказанные списки]] для утверждений, которые независимы друг от друга. Если Вы развиваете линию мысли, предложения напишите в непрерывной последовательности. | + | * Используйте [[wiki:syntax#lists|незаказанные списки]] для утверждений, которые независимы друг от друга. Если вы развиваете линию мысли, предложения напишите в непрерывной последовательности. |
| - | * Используйте [[wiki:syntax#footnotes|сноски]] экономно и только для очень коротких дополнительных замечаний. Если есть намного больше о чем сказать относительно определенной темы, поместите это в новую статью wiki. Если Вы хотите обратиться к другим (внешним) источникам информации, используйте для этого связи([[wiki:syntax#links|ссылки]]). | + | * Используйте [[wiki:syntax#footnotes|сноски]] экономно и только для очень коротких дополнительных замечаний. Если дополнительной информации относительно определенной темы много - лучше поместите это в новую статью wiki. Если вы хотите обратиться к другим (внешним) источникам информации, используйте для этого связи([[wiki:syntax#links|ссылки]]). |
| - | * Таблицы могут увеличить удобочитаемость структурированных данных. Если Вы вставляете таблицу, удостоверьтесь, что у нее есть заголовки ячеек и заголовок самой таблицы,явно выражающий ее содержание (например,« Таблица 1.2: Средние расстояния между планетами»). | + | * Таблицы могут увеличить удобочитаемость структурированных данных. Если вы вставляете таблицу, удостоверьтесь, что у нее есть заголовки ячеек и заголовок самой таблицы, явно выражающий ее содержание (например,« Таблица 1.2: Средние расстояния между планетами»). |
| - | * Большие таблицы имеют тенденцию сложноредактируемых. Рассмотрите представление данных во вложенном списке вместо этого. | + | * Большие таблицы имеют тенденцию сложноредактируемости. Рассмотрите представление данных во вложенном списке вместо этого. |
| | | | |
| - | ===== Language ===== | + | ===== Говорите по-русски ===== |
| - | | + | |
| - | * Пишите надлежащие предложения и используйте документацию для достоверной информации когда это необходимо. | + | |
| - | * Начните каждое предложение с заглавной буквы и закончите его точкой или другой соответствующей пунктуацией. | + | |
| - | * Попытайтесь написать короткие, ясные предложения без слишком большого количества обращения за помощью к придаточным предложениям. Когда Вы думаете, что Вы закончили свою статью, прочитайте ее снова и пересмотрите любое предложение, у которого есть чрезмерно сложная структура. | + | |
| - | * Выберите, как обратиться к Вашим читателям. Так как Wiki приспособлен к письму документации, Вы должны будете часто инструктировать своих читателей, как сделать определенные вещи. Вы можете использовать обязательную форму "Делай это!", или "Вы" форму "Тогда Вы нажимаем на …", или "Я" форму "я ловлю, используя удочку..". Не смешивайте эти формы. | + | |
| - | * **Проверьте свою статью на грамматические или пунктуационные ошибки прежде, чем сохранить.** Если в Вашем тексте будет много ошибок, он уменьшит вероятность Ваших утверждений, независимо от того, как хорошо они могут передать мысль. | + | |
| - | * Развевайте свой собственный стиль. Не вынуждайте себя написать в манере, в которой Вам не удобно. Итог окажется неестественным и его будет неприятно читать. | + | |
| | | | |
| | + | * Пишите надлежащие предложения и используйте документацию для достоверной информации, когда это необходимо. |
| | + | * Начинайте каждое предложение с заглавной буквы и заканчивайте его точкой или другим соответствующим знаком пунктуации. |
| | + | * Попытайтесь написать короткие, ясные предложения без множества обращений придаточных предложений. Когда вы думаете, что статья закончена, перечитайте ее и пересмотрите все предложения со сложной структурой на предмет упрощения. |
| | + | * Выберите способ обращения к вашим читателям. Так как wiki предназначена к описаниям документации, вам часто придется инструктировать своих читателей для выполнения определенных действий. Вы можете использовать обязательную форму "Делай это!", или форму "вы": "Тогда вы нажимаете на "выход"…", или форму "Я": "я ловлю, используя удочку...". Не смешивайте эти формы. |
| | + | * **Проверьте статью на грамматические, лексические или пунктуационные ошибки прежде, чем сохранить.** Не заставляйте читателя плеваться и проклинать вашу безграмотность/кривые руки/кривой мозг. |
| | + | * Используйте свой собственный стиль, пишите привычным вам слогом. В противном случае статья может казаться искуственной и нечитабельной. |
| | | | |
| | ===== Ссылки ===== | | ===== Ссылки ===== |
| | | | |
| - | * Когда Вы сталкиваетесь с термином, который нуждается в большем количестве объяснения, добавьте новую страницу wiki для термина и связи с ним. | + | * Когда вы сталкиваетесь с термином, который нуждается в толковании - добавьте ссылку на объяснение термина или создайте таковое на новой странице. |
| - | * Повторно проверьте свою статью прежде, чем Вы закончите ее, и добавите связи с существующими статьям wiki к центральным срокам Вашей страницы. | + | * Повторно проверьте свою статью прежде, чем завершить ее, добавьте ссылки на существующие статьи wiki. |
| - | * Не добавляйте ссылки с каждым возникновением определенного термина. Сделайте сначала, самые очевидные ссылки в статье и возможно добавьте ссылки на справочные секции. | + | * Не нужно пять раз в одной статье ссылаться на один и тот же термин. Одной (первой) ссылки вполне достаточно. |
| - | * Обеспечьте связи с источниками изображений, данных и цитат. | + | * Обеспечьте связь с источниками изображений, данных и цитат. |
| - | * Рассмотрите добавление «Смотрите также:» в конце Вашей статьи. Обеспечьте связи со статьями wiki, которые близко связаны с темой Вашей статьи. | + | * При необходимости используйте в конце статьи ряд ссылок «Смотрите также:». Обеспечьте связи со статьями wiki, близкими теме вашей статьи. |
| - | * Если Вы хотите дать указатели на внешние ресурсы, у которых есть дополнительная информация относительно Вашей темы или что Вы использовали в написании своей статьи, добавьте секцию под названием "Ссылки" или "Дополнительная информация" в конце и дайте список ссылок или других указателей. Если Вы уже не сделали так в главном тексте, заявите намерение ссылки. | + | * **Если вы хотите дать указатели на внешние ресурсы с дополнительной информацией по вашей теме или сослаться на источник материала для вашей статьи - добавьте секцию под названием "Ссылки" или "Дополнительная информация" в конце статьи.** |
| - | * Настраивание сокращений interwiki может помочь с соединением с общими ресурсами. | + | * Настройка сокращений interwiki может помочь в объединении с общими ресурсами. |
| | | | |
| - | ===== Изображения и другие media ===== | + | ===== Изображения и другие медиаматериалы ===== |
| | | | |
| - | * «Изображение говорят больше чем тысячу слов.» Они передают больше, чем Вы намеревались сказать. Люди имеют тенденцию подвергать сомнению подлинность изображений меньше, чем описание того же просто словами. Короткое текстовое описание лучше чем ничего вообще или чем неточная картинка. | + | * «Изображение скажет больше, чем тысяча слов.» Человек интуитивно больше верит цельной картинке, чем свободно редактируемому тексту. |
| - | * Как с таблицами, всегда обеспечивайте заголовок для изображения, которое заявляет то, что Вы хотите показать на изображение. | + | * Всегда подписывайте изображение согласно его содержанию. |
| - | * Если Вы не создавали картину самостоятельно, заявите источник (возможно с сылкой) и авторское право. | + | * Укажите ссылку на источник и автора изображения - не нарушайте авторское право. |
| - | * Не связывайте изображения от внешних участков, если только подругому никак. Это - во-первых вопрос авторского права, но может также иметь значение когда кэширование для внешних изображений отключено. | + | * Старайтесь не использовать изображения с внешних ресурсов. |
| - | * Если картинка больше чем примерно одна треть страницы экрана, используйте [[wiki:syntax#images_and_other_files|ссылки с изменением размеров]]. | + | * **Если картинка больше одной трети страницы экрана, используйте [[wiki:syntax#images_and_other_files|ссылки с изменением размеров]].** |
| - | * Делая скрин-шот самостоятельно, обращайте внимание на качество итоговой картинки - размытые края изображений, визуальные "шумы" и тому подобное делают картинку неаккуратной. Целесообразно сохранять "скрины" в формате *.PNG. | + | * Делая скриншот самостоятельно, обратите внимание на качество итоговой картинки - размытые края изображений, "шумы", крупное зерно и т. д. делают картинку неаккуратной. Целесообразно сохранять "скрины" в формате *.PNG. |
