Руководство по вводу Wiki

Следующие стандарты должны помочь поддерживать совместимость wiki, легко понять для новичков и легко редактировать для случайных участников..

В некоторых случаях могут быть исключения, когда это имеет смысл, но для этого должна быть веская причина.

1. Статьи должны быть легко читаемыми и легко редактировать, проще. Статьи должны быть отформатированы только с использованием основных функций, найденных в графическом интерфейсе редактора , а также при необходимости использовать тег кода и таблицу.
   Зачем? Более продвинутое форматирование придаст этой вики более «профессиональный» вид, но также будет труднее читать и редактировать для случайных пользователей и вкладчиков. Более продвинутые макеты с вкладками и кнопками более компактны, но, как правило, более сбивают с толку, чем простой макет с одним списком действий и ссылок, где читатели просматривают и щелкают. Также простой неинтерактивный макет позволяет легко печатать. Например, посмотрите на это руководство. Первоначальная установка LEDE на устройстве.
   
   
2. Избегайте дублирования информации в этой вики : информация по той же теме должна появляться в вики только один раз. Если это необходимо в другом месте, мы ссылаемся на него со ссылкой!
   Например, если вы пишете учебник, и один из шагов - «настроить USB-хранилище», вы должны указать ссылку на Использование устройств хранения. Не записывайте (или не копируйте) те же процедуры в новом учебнике!
   
   
3. Избегайте дублирования исходной документации : рассмотрите возможность включения более общих частей документации в вверх, по течению и просто ссылку на статью в вашей статье. Эта вики существует для документации, связанной с OpenWrt, например ipv4. Некоторые примеры upstream wikis: i.e. Linux WiFi drivers wiki, OpenVPN Wiki и.т.д. Не все используют вики, и не все принимают вклады от третьих лиц. Если восходящие взносы невозможны, то это прекрасно, чтобы иметь эту информацию в вики OpenWrt.
   
   
4. Информация о версии: информация в статьях должна быть действительной для текущей стабильной версии. Информация, относящаяся только к более старым или моментальным снимкам (как устаревшим, так и очень новым), должна быть отмечена как таковая.
   
   
5. Статьи должны быть легкими, чтобы найти что большинство людей будут искать информацию в поисковой системе по своему выбору или с собственным внутренним поиском вики. Используйте короткие, описательные заголовки и введения, содержащие правильные ключевые слова, которые можно найти. Вы можете попытаться найти свою статью с помощью своей любимой поисковой системы (через несколько дней вы отправили статью, потому что поисковым системам нужно время для обновления своих индексов). Если вы не найдете свой собственный контент, другие, вероятно, тоже не будут!
   Напримерinstalling.opkg.packages.in.mount.point.other.than.root длинный заголовок , который может быть заменен на что - то вроде opkg - Направления по установке, но последнее не будет так легко найти, как первое, когда кто-то не просматривает вики, но вместо этого использует поисковую систему.
   
   
6. Статьи должны объяснять, почему они существуют, какова их цель. Пожалуйста, добавьте параграф «введение» или два, где вы объясните, какая функция вы настраиваете, и какие потребности могут быть удовлетворены, следуя инструкциям. Это не должно быть очень многословным. Например, первый абзац здесь: Использование генератора изображений (Image Builder)
   
   
7. Статьи должны содержать информацию VERIFIABLE, спекуляция должна быть четко обозначена как таковая . Действительно, это очень важно в любой вики. Укажите источники для утверждений, которые не являются общеизвестными, или пишите достаточно информации, чтобы можно было легко искать источники в Google. Например: проблемы с USB 3.0 и WiFi
   
   
8. Все учебники, которые вы пишете, должны быть протестированы лично или должны иметь предупреждение о том, что при написании их невозможно провести тестирование (и удалить предупреждение, когда кто-то его успешно протестировал).
   
   
9. Одна тема в каждой статье. Статьи должны быть сосредоточены на одной, сфокусированной теме, например, “установка и настройка Adblock”. Общие статьи, охватывающие множество разных тем, например “фильтрация веб-трафика” (где вы говорите об Adblock, прокси-серверах и, возможно, Tor и VPN), должны быть разделены.
   
   
10. Большие учебные пособия следует разделить. Большие учебные пособия, где каждый шаг длинный, должны быть разделены отдельными статьями, каждый из которых охватывает часть шагов. Это еще более важно, если учебник содержит условные или необязательные шаги (например: “сделать шагA, тогда вы можете сделать либо шаг B либо C,а затем сделать D”). Например Factory install: Первоначальная установка LEDE на устройстве или "Пример мир!" для LEDE
    
    
11. Статьи должны быть доступны изнутри wiki Убедитесь, что ваша статья имеет ссылку на одной из основных страниц категорий (ссылки ниже), если это какой-то учебник. Некоторые статьи могут не нуждаться в этом, если они являются частью учебного пособия по нескольким статьям, но снова убедитесь, что ВСЕ статьи могут быть доступны либо на основных страницах категорий, либо на других страницах его учебного пособия по нескольким статьям. Очень популярные статьи также будут связаны из других учебных пособий, как описано в Избегайте дублирования информации в этой вики мантре выше. Для удобного списка страниц, ссылающихся на текущую страницу, щелкните значок “цепочка” который вы найдете на правой панели инструментов (это находится под иконкой часов).
    
    

Чтобы дать Wiki лучшую структуру, мы используем namespaces and categories (and tags):

• Пространства имен самые высокие. В каждом из этих верхних пространств имен должно быть не более 3 (трех) подуровней.
  • about проекте OpenWrt в целом
  • TOH поддерживаемых устройствах под названием «Таблица оборудования».
  • Packages документация о доступных пакетах
  • Загрузка целевой страницы для загрузки прошивки для вашего устройства
  • Документация главной страница документации
  • Wiki страницы о функциях wiki и правилах внесения вики
  • FAQ этот список часто задаваемых вопросов

• Категории обеспечивают первый уровень пространства имен. Они различают различные виды документов:
  • Краткое руководство по быстрому началу работы, используемое для первой установки и настройки или аналогичное.
  • Руководство пользователя большая часть документации для пользователей идет здесь
  • Документация для разработчиков

• Теги разные. Хотя структура является эксклюзивной, вы можете разместить статью только в одной подкатегории, тэги более гибкие. Многие из них могут быть размещены одновременно в одной статье и, таким образом, обеспечивают более гибкую категоризацию. Чтобы воспроизвести это со структурой, мы могли бы писать символические статьи, которые помещаются в разные подкатегории и перенаправляются на одну статью. Но давайте не будем этого делать. Теги будут наиболее полезны, если вы хотите искать маршрутизаторы с определенными функциями.
  • тег Обзор

Боковая панель Чтобы упростить навигацию, мы используем боковую панель, в двух местах, чтобы «оживить» ее, показывать более или менее ссылки в зависимости от того, где вы нажали. Любые изменения должны отражаться в обоих файлах (если это необходимо).

• Боковая панель для раздела документы
• Боковая панель для общего раздела