Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revisionBoth sides next revision
ru:wiki:wikirules [2018/05/22 05:07] – [Мантры] sem5959ru:wiki:wikirules [2018/05/22 05:43] – [Мантры] sem5959
Line 11: Line 11:
 ===== Мантры ===== ===== Мантры =====
   - **Статьи должны быть легко читаемыми и легко редактировать, проще.** Статьи должны быть отформатированы только с использованием основных функций, найденных в графическом интерфейсе редактора , а также при необходимости использовать тег кода и таблицу. \\ Зачем? Более продвинутое форматирование придаст этой вики более «профессиональный» вид, но также будет труднее читать и редактировать для случайных пользователей и вкладчиков. Более продвинутые макеты с вкладками и кнопками более компактны, но, как правило, более сбивают с толку, чем простой макет с одним списком действий и ссылок, где читатели просматривают и щелкают. Также простой неинтерактивный макет позволяет легко печатать. Например, посмотрите на это руководство. [[docs:guide-quick-start:factory_installation|Первоначальная установка LEDE на устройстве]].\\ \\   - **Статьи должны быть легко читаемыми и легко редактировать, проще.** Статьи должны быть отформатированы только с использованием основных функций, найденных в графическом интерфейсе редактора , а также при необходимости использовать тег кода и таблицу. \\ Зачем? Более продвинутое форматирование придаст этой вики более «профессиональный» вид, но также будет труднее читать и редактировать для случайных пользователей и вкладчиков. Более продвинутые макеты с вкладками и кнопками более компактны, но, как правило, более сбивают с толку, чем простой макет с одним списком действий и ссылок, где читатели просматривают и щелкают. Также простой неинтерактивный макет позволяет легко печатать. Например, посмотрите на это руководство. [[docs:guide-quick-start:factory_installation|Первоначальная установка LEDE на устройстве]].\\ \\
-  - **Избегайте дублирования информации в этой вики** : информация по той же теме должна появляться в вики только **//один раз//**. Если это необходимо в другом месте, мы ссылаемся на него со ссылкой!\\ Например, если вы пишете учебник, и один из шагов - «настроить USB-хранилище», вы должны указать ссылку на [[docs:guide-user:storage:usb-drives|Использование устройств хранения]]. НЕ записывайте (или скопируйте-вставить) те же процедуры в своем новом учебнике! \\ \\ +  - **Избегайте дублирования информации в этой вики** : информация по той же теме должна появляться в вики только **//один раз//**. Если это необходимо в другом месте, мы ссылаемся на него со ссылкой!\\ Например, если вы пишете учебник, и один из шагов - «настроить USB-хранилище», вы должны указать ссылку на [[docs:guide-user:storage:usb-drives|Использование устройств хранения]]. Не записывайте (или не копируйте) те же процедуры в новом учебнике! \\ \\ 
-  - **Avoid duplicating upstream documentation** : consider contributing the more generic parts of the documentation to **//upstream//**, and just link to that in your articleThis wiki exists for OpenWrt-related documentationfor example [[docs:guide-user:network:ipv4:start]]. Some example upstream wikis: i.e. [[https://wireless.wiki.kernel.org/|Linux WiFi drivers wiki]], [[https://community.openvpn.net/openvpn/wiki|OpenVPN Wiki]] etcNot all employ wikisand not all accept contributions from third partiesIf upstream contributions are impossiblethen it's fine to have that info in the OpenWrt wiki. \\ \\ +  - **Избегайте дублирования исходной документации** : рассмотрите возможность включения более общих частей документации в **//вверх//**, по **течению** и просто ссылку на статью в вашей статьеЭта вики существует для документации, связанной с OpenWrt, например [[docs:guide-user:network:ipv4:start]]. Некоторые примеры upstream wikis: i.e. [[https://wireless.wiki.kernel.org/|Linux WiFi drivers wiki]], [[https://community.openvpn.net/openvpn/wiki|OpenVPN Wiki]] и.т.д. Не все используют викии не все принимают вклады от третьих лицЕсли восходящие взносы невозможныто это прекрасно, чтобы иметь эту информацию в вики OpenWrt. \\ \\ 
-  - **Versioning information**: the information in the articles should be valid for the **//current stable release//**. Information that applies **only** to older or snapshot releases (either deprecated or very new featuresshould be marked as such. \\ \\ +  - **Информация о версии**: информация в статьях должна быть действительной для **//текущей стабильной версии//**. Информация, относящаяся  **только** к более старым или моментальным снимкам (как устаревшим, так и очень новым), должна быть отмечена как таковая. \\ \\ 
-  - **Articles should be easy to find** most people will search for information with the search engine of their choice, or with the wiki's own internal searchUse shortdescriptive titles and introductions that contain the right keywords to be foundYou can try to search for your article with your favorite search engine (after a few days you posted the articlebecause search engines need time to update their indexes). If you won't find your own contentothers probably won't as well!\\ E.g. **installing.opkg.packages.in.mount.point.other.than.root** is a long title that could be replaced with something like //opkg --  Installation Destinations//but the latter will not be as easily be found as the first one when someone does not browse the wikibut uses a search engine instead. \\ \\ +  - **Статьи должны быть легкими, чтобы найти** что большинство людей будут искать информацию в поисковой системе по своему выбору или с собственным внутренним поиском викиИспользуйте короткиеописательные заголовки и введения, содержащие правильные ключевые слова, которые можно найтиВы можете попытаться найти свою статью с помощью своей любимой поисковой системы (через несколько дней вы отправили статьюпотому что поисковым системам нужно время для обновления своих индексов). Если вы не найдете свой собственный контентдругие, вероятно, тоже не будут! \\  Например**installing.opkg.packages.in.mount.point.other.than.root** длинный заголовок , который может быть заменен на что - то вроде opkg - Направления по установкено последнее не будет так легко найтикак первое, когда кто-то не просматривает вики, но вместо этого использует поисковую систему. \\ \\ 
-  - **Articles should explain why they existwhat is their goal**. Please add an "introduction" paragraph or two where you explain what is the feature you are configuringand what needs can be satisfied by following the instructionsIt does not need to be very verboseFor examplethe first paragraph here: [[docs:guide-user:additional-software:imagebuilder|Using the Image Generator (Image Builder)]] \\ \\ +  - **Статьи должны объяснятьпочему они существуют, какова их цель**. Пожалуйстадобавьте параграф «введение» или два, где вы объясните, какая функция вы настраиваете, и какие потребности могут быть удовлетворены, следуя инструкциямЭто не должно быть очень многословнымНапримерпервый абзац здесь [[docs:guide-user:additional-software:imagebuilder|Использование генератора изображений (Image Builder)]] \\ \\ 
-  - **Articles should contain VERIFIABLE informationspeculation should be clearly labeled as such**. Reallythis is very important in any wikiCite sources for statements that aren't common knowledgeor write enough information to allow easy google searching for sourcesFor example: [[docs:guide-user:network:wifi:usb3.0-wifi-issues|USB 3.0 and WiFi problems]] \\ \\ +  - **Статьи должны содержать информацию VERIFIABLE, спекуляция должна быть четко обозначена как таковая **. Действительноэто очень важно в любой викиУкажите источники для утвержденийкоторые не являются общеизвестными, или пишите достаточно информации, чтобы можно было легко искать источники в GoogleНапример: [[docs:guide-user:network:wifi:usb3.0-wifi-issues|проблемы с USB 3.0 и WiFi]] \\ \\ 
-  - **All tutorials you write must be tested personally or must have a warning** stating that testing was not possible when writing them (and to remove the warning when someone successfully tested it).  \\ \\ +  - **Все учебники, которые вы пишете, должны быть протестированы лично или должны иметь предупреждение** о том, что при написании их невозможно провести тестирование (и удалить предупреждение, когда кто-то его успешно протестировал).  \\ \\ 
-  - **One topic per article**. Articles should be focused on a singlefocused topicfor example "**installing and configuring Adblock**"General articles that span many different topicsfor example "**filtering web traffic**" (where you talk of Adblock, proxy serversand maybe Tor and VPNsshould be split up. \\ \\+  - **Одна тема в каждой статье**. Статьи должны быть сосредоточены на однойсфокусированной теме, например, "**установка и настройка Adblock**"Общие статьиохватывающие множество разных тем, например "**фильтрация веб-трафика**" (где вы говорите об Adblock, прокси-серверах и, возможно, Tor и VPN), должны быть разделены. \\ \\
   - **Large tutorials should be split up**. Large tutorials where each step is long should be split up in separate articles, each covering a part of the steps. This is even more important if the tutorial contains conditional or optional steps (for example: "do step **A**, then you can do either step **B** or **C**, then do **D**").  For example [[docs:guide-quick-start:factory_installation|Factory install: First-time installation of LEDE on a device]] or this [[docs:guide-developer:helloworld:start|"Hello, world!" for LEDE]] \\ \\   - **Large tutorials should be split up**. Large tutorials where each step is long should be split up in separate articles, each covering a part of the steps. This is even more important if the tutorial contains conditional or optional steps (for example: "do step **A**, then you can do either step **B** or **C**, then do **D**").  For example [[docs:guide-quick-start:factory_installation|Factory install: First-time installation of LEDE on a device]] or this [[docs:guide-developer:helloworld:start|"Hello, world!" for LEDE]] \\ \\
   - **Articles should be accessible from within the wiki** Please make sure your article has a link in one of the main Categories pages (links below) if it is some kind of tutorial. Some articles may not need this if they are part of a multi-article tutorial, but again make sure ALL articles can be reached either from the main Categories pages or from the other pages of its multi-article tutorial. Very popular articles will also be linked from within other tutorials, as explained in the **Avoid duplicating information within this wiki** mantra above. For a handy list of pages linking to the current page, click on the "**chain**" icon you find on the right tool panel (it's under the **clock** icon). \\ \\   - **Articles should be accessible from within the wiki** Please make sure your article has a link in one of the main Categories pages (links below) if it is some kind of tutorial. Some articles may not need this if they are part of a multi-article tutorial, but again make sure ALL articles can be reached either from the main Categories pages or from the other pages of its multi-article tutorial. Very popular articles will also be linked from within other tutorials, as explained in the **Avoid duplicating information within this wiki** mantra above. For a handy list of pages linking to the current page, click on the "**chain**" icon you find on the right tool panel (it's under the **clock** icon). \\ \\
  • Last modified: 2019/07/04 05:28
  • by tmomas