| |
| wiki:good_style [2023/08/11 18:02] – создано vladpolskiy | wiki:good_style [2024/08/15 01:53] (текущий) – внешнее изменение 127.0.0.1 |
|---|
| * Располагайте вложенные заголовки в правильном порядке, секции второго уровня должны начинаться с заголовка второго уровня. | * Располагайте вложенные заголовки в правильном порядке, секции второго уровня должны начинаться с заголовка второго уровня. |
| * Разбивайте текст на абзацы, оставляя одну пустую строку между ними. В среднем абзац не должен превышать 10--20 строк. | * Разбивайте текст на абзацы, оставляя одну пустую строку между ними. В среднем абзац не должен превышать 10--20 строк. |
| * Если текст длиннее нескольких (3--5) абзацев, подумайте над разделением его на [[ru:wiki:syntax#разбивка_на_разделы|секции]] путём добавления заголовков первого-пятого уровней. | * Если текст длиннее нескольких (3--5) абзацев, подумайте над разделением его на [[wiki:wiki:syntax#разбивка_на_разделы|секции]] путём добавления заголовков первого-пятого уровней. |
| * Когда текст становится больше двух-трёх экранных страниц, разместите краткое содержание страницы после первого заголовка. Когда страница станет значительно больше, попробуйте разделить её на несколько страниц. | * Когда текст становится больше двух-трёх экранных страниц, разместите краткое содержание страницы после первого заголовка. Когда страница станет значительно больше, попробуйте разделить её на несколько страниц. |
| * Если много ссылок ведут на другие страницы вики или внешние ссылки, добавьте специальный раздел со ссылками. (Подробности [[#ссылки|ниже]]). | * Если много ссылок ведут на другие страницы вики или внешние ссылки, добавьте специальный раздел со ссылками. (Подробности [[#ссылки|ниже]]). |
| * Если большинство страниц [[ru:namespaces|пространства имён]] имеют одинаковую структуру, добавьте [[ru:namespace_templates|шаблон страницы]], и каждая новая страница будет создаваться на основе одного и того же «скелета». | * Если большинство страниц [[wiki:namespaces|пространства имён]] имеют одинаковую структуру, добавьте [[wiki:namespace_templates|шаблон страницы]], и каждая новая страница будет создаваться на основе одного и того же «скелета». |
| * Старайтесь не усложнять структуру системы пространств имён. Старайтесь использовать для них короткие, простые для запоминания названия. | * Старайтесь не усложнять структуру системы пространств имён. Старайтесь использовать для них короткие, простые для запоминания названия. |
| * Прислушивайтесь к рекомендациям [[plugin: qc | плагина проверки качества]] о структуре и форматировании текста. | * Прислушивайтесь к рекомендациям [[plugin: qc | плагина проверки качества]] о структуре и форматировании текста. |
| * Акцентируйте отдельные слова или короткие отрывки текста **жирным шрифтом** или //курсивом//. Выберите один из них и придерживайтесь этого выбора. | * Акцентируйте отдельные слова или короткие отрывки текста **жирным шрифтом** или //курсивом//. Выберите один из них и придерживайтесь этого выбора. |
| * Выберите стиль отображения текста и интерфейса, например, кнопок и пунктов меню, и последовательно применяйте этот стиль. Было бы хорошо добавить страницу, на которой будут излагаться правила оформления вашей вики. | * Выберите стиль отображения текста и интерфейса, например, кнопок и пунктов меню, и последовательно применяйте этот стиль. Было бы хорошо добавить страницу, на которой будут излагаться правила оформления вашей вики. |
| * Используйте [[ru:wiki:syntax#списки|маркированные списки]] для значений, независимых друг от друга. Если вы пишете список целей, делайте это в строку. | * Используйте [[wiki:wiki:syntax#списки|маркированные списки]] для значений, независимых друг от друга. Если вы пишете список целей, делайте это в строку. |
| * Используйте [[ru:wiki:syntax#сноски]] редко и только для очень коротких дополнительных пометок. Если сноска получается длинной, выделите её в отдельную вики-страницу. Если вы хотите сослаться на другой (внешний) ресурс, используйте [[ru:wiki:syntax#ссылки|ссылки]]. | * Используйте [[wiki:wiki:syntax#сноски]] редко и только для очень коротких дополнительных пометок. Если сноска получается длинной, выделите её в отдельную вики-страницу. Если вы хотите сослаться на другой (внешний) ресурс, используйте [[wiki:wiki:syntax#ссылки|ссылки]]. |
| * Таблицы могут сильно улучшить читабельность структурированной информации. Если вы вставляете таблицу, убедитесь, что у неё есть значимые заглавные ячейки и подпись явно соответствует содержанию таблицы (например, «Таблица 1.2. Средние расстояния между планетами»). | * Таблицы могут сильно улучшить читабельность структурированной информации. Если вы вставляете таблицу, убедитесь, что у неё есть значимые заглавные ячейки и подпись явно соответствует содержанию таблицы (например, «Таблица 1.2. Средние расстояния между планетами»). |
| * Большие таблицы очень тяжело редактировать. Попробуйте вместо них применять вложенные списки. | * Большие таблицы очень тяжело редактировать. Попробуйте вместо них применять вложенные списки. |
| * Давайте ссылки на источники изображений, данных и цитат. | * Давайте ссылки на источники изображений, данных и цитат. |
| * Подумайте о разделе «Смотри(те) также» в конце вашей статьи. Давайте в нём ссылки на вики-страницы, которые //близко// связаны со статьёй. | * Подумайте о разделе «Смотри(те) также» в конце вашей статьи. Давайте в нём ссылки на вики-страницы, которые //близко// связаны со статьёй. |
| * Если хотите указать внешние ресурсы, на которых можно найти дополнительную информацию по вашей теме, или которые вы использовали для написания статьи, создайте в её конце секцию «Ссылки» или «Дополнительная информация». В ней дайте список ссылок или других указателей (например, номеров [[wp>ru:ISBN|ISBN]]). Напишите пояснения к ссылкам, если не сделали этого в основном тексте. | * Если хотите указать внешние ресурсы, на которых можно найти дополнительную информацию по вашей теме, или которые вы использовали для написания статьи, создайте в её конце секцию «Ссылки» или «Дополнительная информация». В ней дайте список ссылок или других указателей (например, номеров [[wp>wiki:ISBN|ISBN]]). Напишите пояснения к ссылкам, если не сделали этого в основном тексте. |
| * Использование ярлыков [[ru:interwiki|интервики]] может помочь в связывании с общими ресурсами. | * Использование ярлыков [[wiki:interwiki|интервики]] может помочь в связывании с общими ресурсами. |
| |
| ===== Изображения и медиафайлы ===== | ===== Изображения и медиафайлы ===== |
| * Как и с таблицами, всегда делайте подпись к изображению, которая должна гласить, что вы хотели ею сказать. | * Как и с таблицами, всегда делайте подпись к изображению, которая должна гласить, что вы хотели ею сказать. |
| * Если вы не сами сделали изображение, укажите источник (лучше со ссылкой) и автора (копирайт). | * Если вы не сами сделали изображение, укажите источник (лучше со ссылкой) и автора (копирайт). |
| * Не вставляйте изображения с внешних сайтов, если это не было позволено явно. Во-первых, могут быть проблемы с авторскими правами, а во-вторых, может расходоваться лишний трафик, если выключена опция [[ru:config:fetchsize|кэширования внешних изображений]]. Загружайте изображения в вики, если есть такая возможность. | * Не вставляйте изображения с внешних сайтов, если это не было позволено явно. Во-первых, могут быть проблемы с авторскими правами, а во-вторых, может расходоваться лишний трафик, если выключена опция [[wiki:config:fetchsize|кэширования внешних изображений]]. Загружайте изображения в вики, если есть такая возможность. |
| * Если изображение занимает больше, чем треть страницы, используйте [[ru:wiki:syntax#картинки_и_другие_файлы|ссылку с инструкцией по изменению размера]] для вставки эскиза изображения. | * Если изображение занимает больше, чем треть страницы, используйте [[wiki:wiki:syntax#картинки_и_другие_файлы|ссылку с инструкцией по изменению размера]] для вставки эскиза изображения. |
