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 03:05] – removed sem5959ru:wiki:wikirules [2018/05/22 05:43] – [Мантры] sem5959
Line 1: Line 1:
 +FIXME **This page is not fully translated, yet. Please help completing the translation.**\\ //(remove this paragraph once the translation is finished)//
  
 +====== Руководство по вводу Wiki ======
 +
 +
 +
 +Следующие стандарты должны помочь поддерживать совместимость wiki, легко понять для новичков и легко редактировать для случайных участников..
 +
 +В некоторых случаях могут быть исключения, когда это имеет смысл, но для этого должна быть веская причина.
 +
 +===== Мантры =====
 +  - **Статьи должны быть легко читаемыми и легко редактировать, проще.** Статьи должны быть отформатированы только с использованием основных функций, найденных в графическом интерфейсе редактора , а также при необходимости использовать тег кода и таблицу. \\ Зачем? Более продвинутое форматирование придаст этой вики более «профессиональный» вид, но также будет труднее читать и редактировать для случайных пользователей и вкладчиков. Более продвинутые макеты с вкладками и кнопками более компактны, но, как правило, более сбивают с толку, чем простой макет с одним списком действий и ссылок, где читатели просматривают и щелкают. Также простой неинтерактивный макет позволяет легко печатать. Например, посмотрите на это руководство. [[docs:guide-quick-start:factory_installation|Первоначальная установка LEDE на устройстве]].\\ \\
 +  - **Избегайте дублирования информации в этой вики** : информация по той же теме должна появляться в вики только **//один раз//**. Если это необходимо в другом месте, мы ссылаемся на него со ссылкой!\\ Например, если вы пишете учебник, и один из шагов - «настроить USB-хранилище», вы должны указать ссылку на [[docs:guide-user:storage:usb-drives|Использование устройств хранения]]. Не записывайте (или не копируйте) те же процедуры в новом учебнике! \\ \\
 +  - **Избегайте дублирования исходной документации** : рассмотрите возможность включения более общих частей документации в **//вверх//**, по **течению** и просто ссылку на статью в вашей статье. Эта вики существует для документации, связанной с 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. \\ \\
 +  - **Информация о версии**: информация в статьях должна быть действительной для **//текущей стабильной версии//**. Информация, относящаяся  **только** к более старым или моментальным снимкам (как устаревшим, так и очень новым), должна быть отмечена как таковая. \\ \\
 +  - **Статьи должны быть легкими, чтобы найти** что большинство людей будут искать информацию в поисковой системе по своему выбору или с собственным внутренним поиском вики. Используйте короткие, описательные заголовки и введения, содержащие правильные ключевые слова, которые можно найти. Вы можете попытаться найти свою статью с помощью своей любимой поисковой системы (через несколько дней вы отправили статью, потому что поисковым системам нужно время для обновления своих индексов). Если вы не найдете свой собственный контент, другие, вероятно, тоже не будут! \\  Например**installing.opkg.packages.in.mount.point.other.than.root** длинный заголовок , который может быть заменен на что - то вроде opkg - Направления по установке, но последнее не будет так легко найти, как первое, когда кто-то не просматривает вики, но вместо этого использует поисковую систему. \\ \\
 +  - **Статьи должны объяснять, почему они существуют, какова их цель**. Пожалуйста, добавьте параграф «введение» или два, где вы объясните, какая функция вы настраиваете, и какие потребности могут быть удовлетворены, следуя инструкциям. Это не должно быть очень многословным. Например, первый абзац здесь:  [[docs:guide-user:additional-software:imagebuilder|Использование генератора изображений (Image Builder)]] \\ \\
 +  - **Статьи должны содержать информацию VERIFIABLE, спекуляция должна быть четко обозначена как таковая **. Действительно, это очень важно в любой вики. Укажите источники для утверждений, которые не являются общеизвестными, или пишите достаточно информации, чтобы можно было легко искать источники в Google. Например: [[docs:guide-user:network:wifi:usb3.0-wifi-issues|проблемы с USB 3.0 и WiFi]] \\ \\
 +  - **Все учебники, которые вы пишете, должны быть протестированы лично или должны иметь предупреждение** о том, что при написании их невозможно провести тестирование (и удалить предупреждение, когда кто-то его успешно протестировал).  \\ \\
 +  - **Одна тема в каждой статье**. Статьи должны быть сосредоточены на одной, сфокусированной теме, например, "**установка и настройка 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]] \\ \\
 +  - **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). \\ \\
 +
 +===== Состав ======
 +Чтобы дать Wiki лучшую структуру, мы используем ''namespaces'' and ''categories'' (and ''tags''):
 +  * **Пространства имен** самые высокие. В каждом из этих верхних пространств имен должно быть не более 3 (трех) подуровней.
 +    * //[[about:|about]]// проекте OpenWrt в целом
 +    * //[[toh:|TOH]]// поддерживаемых устройствах под названием «Таблица оборудования».
 +    * //[[packages:|Packages]]// документация о доступных пакетах
 +    * //[[:downloads:|Загрузка]]// целевой страницы для загрузки прошивки для вашего устройства
 +    * //[[docs:|Документация]]// главной страница документации
 +    * //[[wiki:|Wiki]]// страницы о функциях wiki и правилах внесения вики
 +    * //[[faq:|FAQ]]// этот список часто задаваемых вопросов
 +
 +  * **Категории** обеспечивают первый уровень пространства имен. Они различают различные виды **документов**:
 +    * //[[docs:guide-quick-start:begin_here|Краткое]]// руководство по быстрому началу работы, используемое для первой установки и настройки или аналогичное.
 +    * //[[docs:guide-user:|Руководство пользователя]]// большая часть документации для пользователей идет здесь
 +    * //[[docs:guide-developer:|Документация]]// для разработчиков
 +
 +  * **Теги** разные. Хотя структура является эксклюзивной, вы можете разместить статью только в одной подкатегории, тэги более гибкие. Многие из них могут быть размещены одновременно в одной статье и, таким образом, обеспечивают более гибкую категоризацию. Чтобы воспроизвести это со структурой, мы могли бы писать символические статьи, которые помещаются в разные подкатегории и перенаправляются на одну статью. Но давайте не будем этого делать. Теги будут наиболее полезны, если вы хотите искать маршрутизаторы с определенными функциями.
 +    * [[meta:тег]] Обзор
 +
 +**Боковая панель**
 +Чтобы упростить навигацию, мы используем боковую панель, в двух местах, чтобы «оживить» ее, показывать более или менее ссылки в зависимости от того, где вы нажали. Любые изменения должны отражаться в обоих файлах (если это необходимо).
 +    * //[[docs:Боковая панель для раздела документы]]//
 +    * //[[sidebar:|Боковая панель для общего раздела]]//
  • Last modified: 2019/07/04 05:28
  • by tmomas