Содержание Недавние изменения Ссылки сюда
Править страницу История страницы
Содержание

Это — старая версия документа!


Hints on good style

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

Структура статьи

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

Текстовое форматирование

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

Language

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

Ссылки

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

Изображения и другие media

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

Дискуссия

 paspaspas , 2009/04/24 23:15

Эм…на русском языке можно сделать7

 Титькозавр , 2009/04/25 05:40

(с)коро?8-O

 Black Monarh , 2009/04/26 17:11

Чутка перевел;-)

 Титькозавр , 2009/04/26 17:14

Начинаю потрошить страницы следуя указаниям первой части:)

 Black Monarh , 2009/04/26 20:40

Ага, очень много тем где идет сначало заголовок первого уровня а потом третьего=))

 Black Monarh , 2009/04/26 23:37

Добил, если будут какие то общие пожелания для всех я думаю их так же можно сюда включить для дальнейшего поколения викиюзеров.

 phoenix , 2009/04/27 15:53

Начните Вашу статью с заголовка первого уровня со значащим названием.

Если Вы хотите дать указатели на внешние ресурсы, у которых есть дополнительная информация относительно Вашей темы или что Вы использовали в написании своей статьи, добавьте секцию под названием «Ссылки» или «Дополнительная информация» в конце и дайте список ссылок или других указателей.

Если картинка больше чем примерно одна треть страницы экрана, используйте ссылки с изменением размеров.

вот эти пункты надо как-нибудь выделить :-(

 saint-denis , 2009/09/05 02:37

Написал на более человеческом языке.

wiki/style.1240828356.txt.gz · Последние изменения: 2016/01/31 09:41 (внешнее изменение)
Наверх
Браузерная онлайн игра
© 2005—2024 «Грани Реальности»