wiki:style [2009/09/05 02:34] saint-denis |
wiki:style [2016/01/31 09:43] (текущий) |
- | ====== Подсказки для хорошего стиля ====== | + | ====== Советы по стилю статьи ====== |
| | | |
| Вот несколько советов к написанию хорошей wiki-статьи. | | Вот несколько советов к написанию хорошей wiki-статьи. |
| ===== Структура статьи ===== | | ===== Структура статьи ===== |
| | | |
- | * Начните вашу статью с заголовка первого уровня со смысловым названием. | + | * **Начните вашу статью с заголовка первого уровня с осмысленным названием**. |
| * Вставляйте уровни заголовка в их правильном порядке, секции во втором уровне должны начинаться с заголовка второго уровня. | | * Вставляйте уровни заголовка в их правильном порядке, секции во втором уровне должны начинаться с заголовка второго уровня. |
| * Разбейте свой текст на параграфы, оставляя пустую линию между ними. Средний параграф не должен быть длиннее 10-20 предложений. | | * Разбейте свой текст на параграфы, оставляя пустую линию между ними. Средний параграф не должен быть длиннее 10-20 предложений. |
| * Когда ваш текст становится длиннее 2-3-х страниц, рекомендуется поместить короткое резюме содержания статьи после первого заголовка. Когда ваша статья приобретает значительный объем, рассмотрите вариант её разделения на составные статьи. | | * Когда ваш текст становится длиннее 2-3-х страниц, рекомендуется поместить короткое резюме содержания статьи после первого заголовка. Когда ваша статья приобретает значительный объем, рассмотрите вариант её разделения на составные статьи. |
| * Если у вас есть много связок (ссылок) с другими wiki-статьями или внешними ресурсами, добавьте специальную секцию с дальнейшими ссылками (см. ниже)(see [[#references|below]]). | | * Если у вас есть много связок (ссылок) с другими wiki-статьями или внешними ресурсами, добавьте специальную секцию с дальнейшими ссылками (см. ниже)(see [[#references|below]]). |
- | * Если большинство статей [[:namespace]] разделяет общую структуру, добавляется [[:namespace]] шаблон, таким образом любая новая страница может начаться со скелетной структуры. | + | * Если большинство статей [[wiki:namespaces]] разделяет общую структуру, добавляется [[wiki:namespaces]] шаблон, таким образом любая новая страница может начаться со скелетной структуры. |
| * Попытайтесь использовать короткие и легко запоминающиеся названия. | | * Попытайтесь использовать короткие и легко запоминающиеся названия. |
| | | |
| * Большие таблицы имеют тенденцию сложноредактируемости. Рассмотрите представление данных во вложенном списке вместо этого. | | * Большие таблицы имеют тенденцию сложноредактируемости. Рассмотрите представление данных во вложенном списке вместо этого. |
| | | |
- | ===== Language ===== | + | ===== Говорите по-русски ===== |
| | | |
| * Пишите надлежащие предложения и используйте документацию для достоверной информации, когда это необходимо. | | * Пишите надлежащие предложения и используйте документацию для достоверной информации, когда это необходимо. |
| * **Проверьте статью на грамматические, лексические или пунктуационные ошибки прежде, чем сохранить.** Не заставляйте читателя плеваться и проклинать вашу безграмотность/кривые руки/кривой мозг. | | * **Проверьте статью на грамматические, лексические или пунктуационные ошибки прежде, чем сохранить.** Не заставляйте читателя плеваться и проклинать вашу безграмотность/кривые руки/кривой мозг. |
| * Используйте свой собственный стиль, пишите привычным вам слогом. В противном случае статья может казаться искуственной и нечитабельной. | | * Используйте свой собственный стиль, пишите привычным вам слогом. В противном случае статья может казаться искуственной и нечитабельной. |
- | | |
| | | |
| ===== Ссылки ===== | | ===== Ссылки ===== |
| * Когда вы сталкиваетесь с термином, который нуждается в толковании - добавьте ссылку на объяснение термина или создайте таковое на новой странице. | | * Когда вы сталкиваетесь с термином, который нуждается в толковании - добавьте ссылку на объяснение термина или создайте таковое на новой странице. |
| * Повторно проверьте свою статью прежде, чем завершить ее, добавьте ссылки на существующие статьи wiki. | | * Повторно проверьте свою статью прежде, чем завершить ее, добавьте ссылки на существующие статьи wiki. |
- | * Не нужно пять раз в одной статье ссылаться на один и тот же термин. Одной (первой) ссылки вполне достато. | + | * Не нужно пять раз в одной статье ссылаться на один и тот же термин. Одной (первой) ссылки вполне достаточно. |
| * Обеспечьте связь с источниками изображений, данных и цитат. | | * Обеспечьте связь с источниками изображений, данных и цитат. |
| * При необходимости используйте в конце статьи ряд ссылок «Смотрите также:». Обеспечьте связи со статьями wiki, близкими теме вашей статьи. | | * При необходимости используйте в конце статьи ряд ссылок «Смотрите также:». Обеспечьте связи со статьями wiki, близкими теме вашей статьи. |
- | * Если вы хотите дать указатели на внешние ресурсы с дополнительной информацией по вашей теме или сослаться на источник материала для вашей статьи - добавьте секцию под названием "Ссылки" или "Дополнительная информация" в конце статьи. | + | * **Если вы хотите дать указатели на внешние ресурсы с дополнительной информацией по вашей теме или сослаться на источник материала для вашей статьи - добавьте секцию под названием "Ссылки" или "Дополнительная информация" в конце статьи.** |
- | * Настраивание сокращений interwiki может помочь в соединении с общими ресурсами. | + | * Настройка сокращений interwiki может помочь в объединении с общими ресурсами. |
| | | |
| ===== Изображения и другие медиаматериалы ===== | | ===== Изображения и другие медиаматериалы ===== |
| * Укажите ссылку на источник и автора изображения - не нарушайте авторское право. | | * Укажите ссылку на источник и автора изображения - не нарушайте авторское право. |
| * Старайтесь не использовать изображения с внешних ресурсов. | | * Старайтесь не использовать изображения с внешних ресурсов. |
- | * Если картинка больше одной трети страницы экрана, используйте [[wiki:syntax#images_and_other_files|ссылки с изменением размеров]]. | + | * **Если картинка больше одной трети страницы экрана, используйте [[wiki:syntax#images_and_other_files|ссылки с изменением размеров]].** |
| * Делая скриншот самостоятельно, обратите внимание на качество итоговой картинки - размытые края изображений, "шумы", крупное зерно и т. д. делают картинку неаккуратной. Целесообразно сохранять "скрины" в формате *.PNG. | | * Делая скриншот самостоятельно, обратите внимание на качество итоговой картинки - размытые края изображений, "шумы", крупное зерно и т. д. делают картинку неаккуратной. Целесообразно сохранять "скрины" в формате *.PNG. |