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

Различия

Здесь показаны различия между выбранной ревизией и текущей версией данной страницы.

wiki:style [2009/04/26 16:04]
Black Monarh
wiki:style [2016/01/31 09:43] (текущий)
Строка 1: Строка 1:
-====== Hints on good style ======+====== Советы по стилю статьи ======
-Вот несколько советов как написать хорошую wiki статью.+Вот несколько советов к написанию хорошей wiki-статьи.
-===== Page structure =====+===== Структура статьи =====
-  * Begin your page with a first level heading with a meaningful title+  * **Начните вашу статью с заголовка первого уровня с осмысленным названием**
-  * Nest headline levels in their correct order, sections in the second level should start with a second level headline+  * Вставляйте уровни заголовка в их правильном порядке, секции во втором уровне должны начинаться с заголовка второго уровня
-  * Break up your text in paragraphs by leaving an empty line between them. An average paragraph should not be longer than 10-20 lines+  * Разбейте свой текст на параграфы, оставляя пустую линию между ними. Средний параграф не должен быть длиннее 10-20 предложений
-  * If your text is longer than a few (3-5) paragraphs, consider dividing it up into [[:syntax#sectioning|sections]] by adding second-to-fifth level headings+  * Если ваш текст длиннее 3-5 параграфов, рассмотрите деление его в [[wiki:syntax#sectioning|секции]], добавляя заголовки со второго по пятый уровни
-  * When your text gets longer than 2-3 screen pages, put a short abstract of the contents of the page after the first heading. When your page gets significantly longer consider splitting it up in multiple pages+  * Когда ваш текст становится длиннее 2-3-х страниц, рекомендуется поместить короткое резюме содержания статьи после первого заголовка. Когда ваша статья приобретает значительный объем, рассмотрите вариант её разделения на составные статьи
-  * If you have many links to other wiki pages or external resources, add a special section with further references (see [[#references|below]]). +  * Если у вас есть много связок (ссылок) с другими  wiki-статьями или внешними ресурсами, добавьте специальную секцию с дальнейшими ссылками (см. ниже)(see [[#references|below]]). 
-  * If most of the pages of a [[:namespace]] share a common structure add a [[:namespace template]] so any new page can begin with that skeleton structure+  * Если большинство статей [[wiki:namespaces]] разделяет общую структуру, добавляется [[wiki:namespaces]] шаблон, таким образом любая новая страница может начаться со скелетной структуры
-  * Try to avoid overcomplicated namespace structures. Try to use short, easy to remember namespace names.+  * Попытайтесь использовать короткие и легко запоминающиеся названия.
-===== Text formatting =====+===== Текстовое форматирование =====
-  * Emphasize single words or short passages of text by using **bold** or //italics//. Choose one of them and stick to your choice+  * Выделяйте отдельные важные слова или словосочетания используя **жирный** или //курсив//. Выберите что-то одно и придерживайтесь своего выбора
-  * Choose a style for representing screen output and text on the screen like buttons or menu labels and use it consistently. It might be a good idea to add a page with an explanation of your style conventions to your wiki. +  * Выберите стиль для того, чтобы представить изображения и текст на экране как кнопки или лейблы меню и используйте это последовательно("При создании статьи формируется ее содержание из заголовков 1-3 уровня. Необходимо иметь последовательность для удобства воспринимаемой инфы. Других объяснений данного пункта не вижу"-(с) Black Monarh). Хорошая идея добавить статью с объяснением Наших соглашений стиля к Нашей wiki. 
-  * Use [[:syntax#lists|unordered lists]] for statements that are independent of each other. If you are developing a line of thought, write in a continuous sequence of sentences+  * Используйте [[wiki:syntax#lists|незаказанные списки]] для утверждений, которые независимы друг от друга. Если вы развиваете линию мысли, предложения напишите в непрерывной последовательности
-  * Use [[:syntax#footnotes|footnotes]] sparingly and only for very short additional remarks. If there is much more to say on a specific topic, put it on a new wiki page. If you want to refer to other (external) information sources, use [[:syntax#links|links]] instead+  * Используйте [[wiki:syntax#footnotes|сноски]] экономно и только для очень коротких дополнительных замечаний. Если дополнительной информации относительно определенной темы много - лучше поместите это в новую статью wiki. Если вы хотите обратиться к другим (внешним) источникам информации, используйте для этого связи([[wiki:syntax#links|ссылки]])
-  * Tables can greatly enhance the readability of structured data. If you insert a table, make sure it has meaningful cell headers and provide a caption that clearly states the contents of the table (e.g. "Table 1.2: Average distances between the planets"). +  * Таблицы могут увеличить удобочитаемость структурированных данных. Если вы вставляете таблицу, удостоверьтесь, что у нее есть заголовки ячеек и заголовок самой таблицы, явно выражающий ее содержание (например,« Таблица 1.2: Средние расстояния между планетами»). 
-  * Large tables tend to be very hard to edit. Consider representing its data in a nested list instead.+  * Большие таблицы имеют тенденцию сложноредактируемости. Рассмотрите представление данных во вложенном списке вместо этого.
-===== Language =====+===== Говорите по-русски =====
-  * Write proper sentences and use articles for nouns when necessary+  * Пишите надлежащие предложения и используйте документацию для достоверной информации, когда это необходимо
-  * Begin each sentence with a capital letter and end it with a full stop or other appropriate punctuation+  * Начинайте каждое предложение с заглавной буквы и заканчивайте его точкой или другим соответствующим знаком пунктуации
-  * Try to write short, clear sentences without too much recourse to subordinate clauses. When you think that you have finished your page, read it again and revise any sentence that has an overly complicated structure+  * Попытайтесь написать короткие, ясные предложения без множества обращений придаточных предложений. Когда вы думаете, что статья закончена, перечитайте ее и пересмотрите все предложения со сложной структурой на предмет упрощения
-  * Decide on how to address your readers. Since DokuWiki is geared towards writing documentation, you will often have to instruct your readers, how to do certain things. You can use the //imperative// form ("//Do// this!"), the //we/you// form ("Then //we/you// click on...") or the //I// form ("//I// then add the foo to bar, using..."). Do not mix these forms+  * Выберите способ обращения к вашим читателям. Так как wiki предназначена к описаниям документации, вам часто придется инструктировать своих читателей для выполнения определенных действий. Вы можете использовать обязательную форму "Делай это!", или форму "вы": "Тогда вы нажимаете на "выход"…", или форму "Я": "я ловлю, используя удочку...". Не смешивайте эти формы
-  * Check your page for grammatical or spelling errors before saving it. If your text shows many errors, it will decrease the credibility of your statements, regardless of how well-thought they may be+  * **Проверьте статью на грамматические, лексические или пунктуационные ошибки прежде, чем сохранить.** Не заставляйте читателя плеваться и проклинать вашу безграмотность/кривые руки/кривой мозг
-  * Develop your own style. Don't force yourself to write in a manner you are not comfortable with. This would only sound unnatural and be unpleasant to read.+  * Используйте свой собственный стиль, пишите привычным вам слогом. В противном случае статья может казаться искуственной и нечитабельной.
 +===== Ссылки =====
-===== References ===== +  * Когда вы сталкиваетесь с термином, который нуждается в толковании - добавьте  ссылку на объяснение термина или создайте таковое на новой странице
- +  * Повторно проверьте свою статью прежде, чем завершить ее, добавьте ссылки на существующие статьи wiki. 
-  * When you come across a term that needs more explanation, add a new wiki page for the term and link to it+  * Не нужно пять раз в одной статье ссылаться на один и тот же термин. Одной (первой) ссылки вполне достаточно
-  * Re-check your page before you finish it, and add links to existing wiki pages to the central terms of your page+  * Обеспечьте связь с источниками изображений, данных и цитат
-  * Don't add a link to every occurrence of a specific term. Make the first/most prominent occurrence on the page a link and maybe add a link to the reference section+  * При необходимости используйте в конце статьи ряд ссылок «Смотрите также:». Обеспечьте связи со статьями wiki, близкими теме вашей статьи
-  * Provide links to the sources of images, data and quotes+  * **Если вы хотите дать указатели на внешние ресурсы с дополнительной информацией по вашей теме или сослаться на источник материала для вашей статьи - добавьте секцию под названием "Ссылки" или "Дополнительная информация" в конце статьи.** 
-  * Consider adding a "See also:" line at the end of your page. Provide links to wiki pages that are //closely// related to the topic of your page there+  * Настройка сокращений interwiki может помочь в объединении с общими ресурсами.
-  * If you want to give pointers to external resources that have further information on your topic or that you used in writing your page, add a section called "References" or "Further information" at the end and give a list of links or other pointers (e.g. ISBN numbers). If you have not already done so in the main text, state the intent of the reference. +
-  * Setting up [[:interwiki]] shortcuts can help with linking to common resources. +
- +
-===== Images and other media ===== +
- +
-  * "An image says more than a thousand words." It might even mean //more than you intended// to say. Humans tend to question the authenticity of images less than that of language. A short textual description is better than nothing at all or than an inaccurate picture. +
-  * As with tables, always provide a caption for images, that states what you want to show with the image. +
-  * If you did not create the picture yourself, state the source (possibly with a link) and the copyright. +
-  * Don't link images from external sites, unless when allowed to do so explicitly. This is firstly a matter of copyright but can also be a matter of bandwidth stealing when [[config:fetchsize|caching for external images]] is disabled. +
-  * If the picture is bigger than roughly a third of a screen page, use a [[:syntax#images_and_other_files|link with resizing instructions]] to insert a thumbnail.+
 +===== Изображения и другие медиаматериалы =====
 +  * «Изображение скажет больше, чем тысяча слов.» Человек интуитивно больше верит цельной картинке, чем свободно редактируемому тексту.
 +  * Всегда подписывайте изображение согласно его содержанию.
 +  * Укажите ссылку на источник и автора изображения - не нарушайте авторское право.
 +  * Старайтесь не использовать изображения с внешних ресурсов.
 +  * **Если картинка больше одной трети страницы экрана, используйте [[wiki:syntax#images_and_other_files|ссылки с изменением размеров]].**
 +  * Делая скриншот самостоятельно, обратите внимание на качество итоговой картинки - размытые края изображений, "шумы", крупное зерно и т. д. делают картинку неаккуратной. Целесообразно сохранять "скрины" в формате *.PNG.
wiki/style.1240747442.txt.gz · Последние изменения: 2016/01/31 09:41 (внешнее изменение)
Наверх
Браузерная онлайн игра
© 2005—2024 «Грани Реальности»