Подсказки для хорошего стиля

Вот несколько советов к написанию хорошей wiki-статьи.

• Начните вашу статью с заголовка первого уровня с осмысленным названием.
• Вставляйте уровни заголовка в их правильном порядке, секции во втором уровне должны начинаться с заголовка второго уровня.
• Разбейте свой текст на параграфы, оставляя пустую линию между ними. Средний параграф не должен быть длиннее 10-20 предложений.
• Если ваш текст длиннее 3-5 параграфов, рассмотрите деление его в секции, добавляя заголовки со второго по пятый уровни.
• Когда ваш текст становится длиннее 2-3-х страниц, рекомендуется поместить короткое резюме содержания статьи после первого заголовка. Когда ваша статья приобретает значительный объем, рассмотрите вариант её разделения на составные статьи.
• Если у вас есть много связок (ссылок) с другими wiki-статьями или внешними ресурсами, добавьте специальную секцию с дальнейшими ссылками (см. ниже)(see below!).
• Если большинство статей namespace разделяет общую структуру, добавляется namespace шаблон, таким образом любая новая страница может начаться со скелетной структуры.
• Попытайтесь использовать короткие и легко запоминающиеся названия.

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

• Пишите надлежащие предложения и используйте документацию для достоверной информации, когда это необходимо.
• Начинайте каждое предложение с заглавной буквы и заканчивайте его точкой или другим соответствующим знаком пунктуации.
• Попытайтесь написать короткие, ясные предложения без множества обращений придаточных предложений. Когда вы думаете, что статья закончена, перечитайте ее и пересмотрите все предложения со сложной структурой на предмет упрощения.
• Выберите способ обращения к вашим читателям. Так как wiki предназначена к описаниям документации, вам часто придется инструктировать своих читателей для выполнения определенных действий. Вы можете использовать обязательную форму «Делай это!», или форму «вы»: «Тогда вы нажимаете на «выход»…», или форму «Я»: «я ловлю, используя удочку…». Не смешивайте эти формы.
• Проверьте статью на грамматические, лексические или пунктуационные ошибки прежде, чем сохранить. Не заставляйте читателя плеваться и проклинать вашу безграмотность/кривые руки/кривой мозг.
• Используйте свой собственный стиль, пишите привычным вам слогом. В противном случае статья может казаться искуственной и нечитабельной.

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

• «Изображение скажет больше, чем тысяча слов.» Человек интуитивно больше верит цельной картинке, чем свободно редактируемому тексту.
• Всегда подписывайте изображение согласно его содержанию.
• Укажите ссылку на источник и автора изображения - не нарушайте авторское право.
• Старайтесь не использовать изображения с внешних ресурсов.
• Если картинка больше одной трети страницы экрана, используйте ссылки с изменением размеров.
• Делая скриншот самостоятельно, обратите внимание на качество итоговой картинки - размытые края изображений, «шумы», крупное зерно и т. д. делают картинку неаккуратной. Целесообразно сохранять «скрины» в формате *.PNG.