DokuWiki

It's better when it's simple

Инструменты пользователя

Инструменты сайта


ru:tips:good_style

Различия

Показаны различия между двумя версиями страницы.

Ссылка на это сравнение

Предыдущая версия справа и слеваПредыдущая версия
Следующая версия
Предыдущая версия
ru:tips:good_style [2010-09-23 00:51] Aleksandrru:tips:good_style [2023-09-28 11:59] (текущий) – [Форматирование текста] 178.176.114.154
Строка 1: Строка 1:
 ====== Советы по соблюдению стиля ====== ====== Советы по соблюдению стиля ======
  
-Вот несколько советов на тему создания хорошей вики-страницы.+Несколько советов, как писать хорошие вики-страницы.
  
 ===== Структура страницы ===== ===== Структура страницы =====
  
-  * Начните страницу с заголовка первого уровня, дайте ему адекватным названием.+  * Начинайте свою страницу с заголовка первого уровня с использованием значимого (осмысленного) названия.
   * Располагайте вложенные заголовки в правильном порядке, секции второго уровня должны начинаться с заголовка второго уровня.   * Располагайте вложенные заголовки в правильном порядке, секции второго уровня должны начинаться с заголовка второго уровня.
-  * Разбивайте текст на параграфы, оставляя пустую линию между ними. В среднем параграф не должен быть длиннее 10--20 строк. +  * Разбивайте текст на абзацы, оставляя одну пустую строку между ними. В среднем абзац не должен превышать 10--20 строк. 
-  * Если текст длиннее нескольких (3--5) параграфов, подумайте над разделением его на [[ru:syntax#разбивка_на_разделы|секции]] путём добавления заголовков первого-пятого уровней.  +  * Если текст длиннее нескольких (3--5) абзацев, подумайте над разделением его на [[ru:wiki:syntax#разбивка_на_разделы|секции]] путём добавления заголовков первого-пятого уровней.  
-  * Когда текст становится больше 2--3 экранных страниц, разместите краткое содержание страницы после первого заголовка. Когда страница станет значительно больше, попробуйте разделить её на несколько страниц. +  * Когда текст становится больше двух-трёх экранных страниц, разместите краткое содержание страницы после первого заголовка. Когда страница станет значительно больше, попробуйте разделить её на несколько страниц. 
-  * Если в тексте много ссылок на другие вики-страницы или внешние ресурсы, добавьте специальную секцию со сносками (смотрите [[#ссылки|ниже]]).+  * Если много ссылок ведут на другие страницы вики или внешние ссылки, добавьте специальный раздел со ссылками(Подробности [[#ссылки|ниже]]).
   * Если большинство страниц [[ru:namespaces|пространства имён]] имеют одинаковую структуру, добавьте [[ru:namespace_templates|шаблон страницы]], и каждая новая страница будет создаваться на основе одного и того же «скелета».   * Если большинство страниц [[ru:namespaces|пространства имён]] имеют одинаковую структуру, добавьте [[ru:namespace_templates|шаблон страницы]], и каждая новая страница будет создаваться на основе одного и того же «скелета».
   * Старайтесь не усложнять структуру системы пространств имён. Старайтесь использовать для них короткие, простые для запоминания названия.   * Старайтесь не усложнять структуру системы пространств имён. Старайтесь использовать для них короткие, простые для запоминания названия.
 +  * Прислушивайтесь к рекомендациям [[plugin: qc | плагина проверки качества]] о структуре и форматировании текста.
  
 ===== Форматирование текста ===== ===== Форматирование текста =====
Строка 18: Строка 19:
   * Акцентируйте отдельные слова или короткие отрывки текста **жирным шрифтом** или //курсивом//. Выберите один из них и придерживайтесь этого выбора.   * Акцентируйте отдельные слова или короткие отрывки текста **жирным шрифтом** или //курсивом//. Выберите один из них и придерживайтесь этого выбора.
   * Выберите стиль отображения текста и интерфейса, например, кнопок и пунктов меню, и последовательно применяйте этот стиль. Было бы хорошо добавить страницу, на которой будут излагаться правила оформления вашей вики.   * Выберите стиль отображения текста и интерфейса, например, кнопок и пунктов меню, и последовательно применяйте этот стиль. Было бы хорошо добавить страницу, на которой будут излагаться правила оформления вашей вики.
-  * Используйте [[ru:syntax#списки|маркированные списки]] для значений, независимых друг от друга. Если вы пишете список целей, делайте это в строку. +  * Используйте [[ru:wiki:syntax#списки|маркированные списки]] для значений, независимых друг от друга. Если вы пишете список целей, делайте это в строку. 
-  * Используйте [[ru:syntax#сноски]] редко и только для очень коротких дополнительных пометок. Если сноска получается длинной, выделите её в отдельную вики-страницу. Если вы хотите сослаться на другой (внешний) ресурс, используйте [[ru:syntax#ссылки|ссылки]]. +  * Используйте [[ru:wiki:syntax#сноски]] редко и только для очень коротких дополнительных пометок. Если сноска получается длинной, выделите её в отдельную вики-страницу. Если вы хотите сослаться на другой (внешний) ресурс, используйте [[ru:wiki:syntax#ссылки|ссылки]]. 
-  * Таблицы могут сильно улучшить читабельность структурированной информации. Если вы вставляете страницу, убедитесь, что у неё есть значимые заглавные ячейки и подпись ясно соответствует содержанию таблицы (например, «Таблица 1.2Средние расстояния между планетами»).+  * Таблицы могут сильно улучшить читабельность структурированной информации. Если вы вставляете таблицу, убедитесь, что у неё есть значимые заглавные ячейки и подпись явно соответствует содержанию таблицы (например, «Таблица 1.2Средние расстояния между планетами»).
   * Большие таблицы очень тяжело редактировать. Попробуйте вместо них применять вложенные списки.   * Большие таблицы очень тяжело редактировать. Попробуйте вместо них применять вложенные списки.
- 
 ===== Язык (слог) ===== ===== Язык (слог) =====
  
-  * Начинайте каждое слово с заглавной буквы и заканчивайте точкой или другим подходящим знаком препинния.+  * Начинайте каждое предложение с заглавной буквы и заканчивайте точкой или другим подходящим знаком препинания.
   * Старайтесь писать короткие, ясные предложения, не усложняя их. Когда вы посчитаете, что закончили страницу, прочитайте её ещё раз и исправьте все слишком сложные предложения.   * Старайтесь писать короткие, ясные предложения, не усложняя их. Когда вы посчитаете, что закончили страницу, прочитайте её ещё раз и исправьте все слишком сложные предложения.
   * Решите, как обращаться к читателю. Так как «ДокуВики» обычно используется для написания документации, вам часто придётся инструктировать читателя, объяснять ему, как делать некие вещи. Вы можете использовать побудительную форму («Делай это»), или обращаться безлично («Нужно сделать то-то»). В первом случае нужно выбрать обращение на «ты» или «вы». И всегда придерживайтесь выбранного стиля.   * Решите, как обращаться к читателю. Так как «ДокуВики» обычно используется для написания документации, вам часто придётся инструктировать читателя, объяснять ему, как делать некие вещи. Вы можете использовать побудительную форму («Делай это»), или обращаться безлично («Нужно сделать то-то»). В первом случае нужно выбрать обращение на «ты» или «вы». И всегда придерживайтесь выбранного стиля.
Строка 37: Строка 37:
   * Не добавляйте ссылку при каждом употреблении специфического термина. Сделайте ссылку для первого или самого заметного употребления, и, возможно, в разделе ссылок.   * Не добавляйте ссылку при каждом употреблении специфического термина. Сделайте ссылку для первого или самого заметного употребления, и, возможно, в разделе ссылок.
   * Давайте ссылки на источники изображений, данных и цитат.   * Давайте ссылки на источники изображений, данных и цитат.
-  * Подумайте о разделе «Смотри(те) также:» в конце вашей статьи. Давайте в нём ссылки на вики-страницы, которые //близко// связаны со статьёй. +  * Подумайте о разделе «Смотри(те) также» в конце вашей статьи. Давайте в нём ссылки на вики-страницы, которые //близко// связаны со статьёй. 
-  * Если хотите указать внешние ресурсы, на которых можно найти дополнительную информацию по вашей теме, или которые вы использовали для написания статьи, создайте в её конце секцию «Ссылки» или «Дополнительная информация». В ней дайте список ссылок или других указателей (например, номеров  ISBN). Напишите пояснения к ссылкам, если не сделали этого в основном тексте.+  * Если хотите указать внешние ресурсы, на которых можно найти дополнительную информацию по вашей теме, или которые вы использовали для написания статьи, создайте в её конце секцию «Ссылки» или «Дополнительная информация». В ней дайте список ссылок или других указателей (например, номеров  [[wp>ru:ISBN|ISBN]]). Напишите пояснения к ссылкам, если не сделали этого в основном тексте.
   * Использование ярлыков [[ru:interwiki|интервики]] может помочь в связывании с общими ресурсами.   * Использование ярлыков [[ru:interwiki|интервики]] может помочь в связывании с общими ресурсами.
  
Строка 45: Строка 45:
   * «Картинка говорит больше, чем тысяча слов». Это также означает --- //больше, чем вы собирались сказать//. Люди меньше сомневаются в достоверности изображений, чем слов. Короткое текстовое описание --- это лучше, чем ничего или неподходящая картинка.   * «Картинка говорит больше, чем тысяча слов». Это также означает --- //больше, чем вы собирались сказать//. Люди меньше сомневаются в достоверности изображений, чем слов. Короткое текстовое описание --- это лучше, чем ничего или неподходящая картинка.
   * Как и с таблицами, всегда делайте подпись к изображению, которая должна гласить, что вы хотели ею сказать.   * Как и с таблицами, всегда делайте подпись к изображению, которая должна гласить, что вы хотели ею сказать.
-  * Если вы не сами сделали изображение, укажите источник (лучше со ссылкой) и копирайт. +  * Если вы не сами сделали изображение, укажите источник (лучше со ссылкой) и автора (копирайт)
-  * Не вставляйте изображения с внешних сайтов, если это не было позволено явно. Во-первых, может быть проблема с копирайтом, а во-вторых, может расходоваться лишний трафик, если выключена опция [[ru:config:fetchsize|кэширования внешних изображений]]. +  * Не вставляйте изображения с внешних сайтов, если это не было позволено явно. Во-первых, могут быть проблемы с авторскими правами, а во-вторых, может расходоваться лишний трафик, если выключена опция [[ru:config:fetchsize|кэширования внешних изображений]]. Загружайте изображения в вики, если есть такая возможность
-  * Если картинка больше, чем на треть экрана, испольуйте [[ru:syntax#картинки_и_другие_файлы|ссылку с опциями изменения размера]], чтобы вставить превью.+  * Если изображение занимает больше, чем треть страницы, используйте [[ru:wiki:syntax#картинки_и_другие_файлы|ссылку с инструкцией по изменению размера]] для вставки эскиза изображения.
ru/tips/good_style.1285195882.txt.gz · Последнее изменение: 2010-09-23 00:51 — Aleksandr

Если не указано иное, содержимое этой вики предоставляется на условиях следующей лицензии: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki