Советы по соблюдению стиля

Несколько советов, как писать хорошие вики-страницы.

• Начинайте свою страницу с заголовка первого уровня с использованием значимого (осмысленного) названия.
• Располагайте вложенные заголовки в правильном порядке, секции второго уровня должны начинаться с заголовка второго уровня.
• Разбивайте текст на абзацы, оставляя одну пустую строку между ними. В среднем абзац не должен превышать 10–20 строк.
• Если текст длиннее нескольких (3–5) абзацев, подумайте над разделением его на секции путём добавления заголовков первого-пятого уровней.
• Когда текст становится больше двух-трёх экранных страниц, разместите краткое содержание страницы после первого заголовка. Когда страница станет значительно больше, попробуйте разделить её на несколько страниц.
• Если много ссылок ведут на другие страницы вики или внешние ссылки, добавьте специальный раздел со ссылками. (Подробности ниже).
• Если большинство страниц пространства имён имеют одинаковую структуру, добавьте шаблон страницы, и каждая новая страница будет создаваться на основе одного и того же «скелета».
• Старайтесь не усложнять структуру системы пространств имён. Старайтесь использовать для них короткие, простые для запоминания названия.
• Прислушивайтесь к рекомендациям плагина проверки качества о структуре и форматировании текста.

• Акцентируйте отдельные слова или короткие отрывки текста жирным шрифтом или курсивом. Выберите один из них и придерживайтесь этого выбора.
• Выберите стиль отображения текста и интерфейса, например, кнопок и пунктов меню, и последовательно применяйте этот стиль. Было бы хорошо добавить страницу, на которой будут излагаться правила оформления вашей вики.
• Используйте маркированные списки для значений, независимых друг от друга. Если вы пишете список целей, делайте это в строку.
• Используйте сноски редко и только для очень коротких дополнительных пометок. Если сноска получается длинной, выделите её в отдельную вики-страницу. Если вы хотите сослаться на другой (внешний) ресурс, используйте ссылки.
• Таблицы могут сильно улучшить читабельность структурированной информации. Если вы вставляете таблицу, убедитесь, что у неё есть значимые заглавные ячейки и подпись явно соответствует содержанию таблицы (например, «Таблица 1.2. Средние расстояния между планетами»).
• Большие таблицы очень тяжело редактировать. Попробуйте вместо них применять вложенные списки.

• Начинайте каждое предложение с заглавной буквы и заканчивайте точкой или другим подходящим знаком препинания.
• Старайтесь писать короткие, ясные предложения, не усложняя их. Когда вы посчитаете, что закончили страницу, прочитайте её ещё раз и исправьте все слишком сложные предложения.
• Решите, как обращаться к читателю. Так как «ДокуВики» обычно используется для написания документации, вам часто придётся инструктировать читателя, объяснять ему, как делать некие вещи. Вы можете использовать побудительную форму («Делай это»), или обращаться безлично («Нужно сделать то-то»). В первом случае нужно выбрать обращение на «ты» или «вы». И всегда придерживайтесь выбранного стиля.
• Перед сохранением проверяйте страницу на грамматические ошибки и опечатки. Если в тексте много ошибок, это снизит убедительность статьи независимо от содержащейся в ней информации.
• Выработайте собственный стиль. Не заставляйте себя писать в некомфортной для себя манере. Это будет лишь ненатурально выглядеть и неприятно читать.

• Когда вы используете термин, требующий объяснения, добавьте новую вики-страницу и сошлитесь на неё.
• Перепроверьте свою страницу перед тем, как закончите её редактировать, и добавьте ссылки на существующие вики-страницы основных терминов вашей статьи.
• Не добавляйте ссылку при каждом употреблении специфического термина. Сделайте ссылку для первого или самого заметного употребления, и, возможно, в разделе ссылок.
• Давайте ссылки на источники изображений, данных и цитат.
• Подумайте о разделе «Смотри(те) также» в конце вашей статьи. Давайте в нём ссылки на вики-страницы, которые близко связаны со статьёй.
• Если хотите указать внешние ресурсы, на которых можно найти дополнительную информацию по вашей теме, или которые вы использовали для написания статьи, создайте в её конце секцию «Ссылки» или «Дополнительная информация». В ней дайте список ссылок или других указателей (например, номеров ISBN). Напишите пояснения к ссылкам, если не сделали этого в основном тексте.
• Использование ярлыков интервики может помочь в связывании с общими ресурсами.

• «Картинка говорит больше, чем тысяча слов». Это также означает — больше, чем вы собирались сказать. Люди меньше сомневаются в достоверности изображений, чем слов. Короткое текстовое описание — это лучше, чем ничего или неподходящая картинка.
• Как и с таблицами, всегда делайте подпись к изображению, которая должна гласить, что вы хотели ею сказать.
• Если вы не сами сделали изображение, укажите источник (лучше со ссылкой) и автора (копирайт).
• Не вставляйте изображения с внешних сайтов, если это не было позволено явно. Во-первых, могут быть проблемы с авторскими правами, а во-вторых, может расходоваться лишний трафик, если выключена опция кэширования внешних изображений. Загружайте изображения в вики, если есть такая возможность.
• Если изображение занимает больше, чем треть страницы, используйте ссылку с инструкцией по изменению размера для вставки эскиза изображения.