Содержание
Основные положения
Старайтесь максимально полно и подробно описывать все вопросы, затрагиваемые в статье. При этом всячески приветствуются ссылки на другие статьи, в которых более детально рассматриваются те или иные аспекты. Однако при этом не стоит отходить от темы статьи и устраивать из описания решения одного вопроса полное руководство пользователя Ubuntu Linux. Фактически, хорошая статья обязательно должна удовлетворять двум следующим требованиям:
- Пользователь, прочитав её, должен получить полное представление об обсуждаемом вопросе, но при этом не должен искать нужную информацию среди кучи мусора, напрямую к статье не относящегося.
- Однако при желании пользователь должен иметь возможность получить более подробную информацию по тем или иным используемым в статье аспектам. Т.е. старайтесь давать ссылки на другие статьи везде, где это возможно. Например, все стандартные операции обязаны сопровождаться ссылками на соответствующие статьи.
Потенциально опасные действия
Любая статья, размещаемая в вики, должна составляться исходя из того, что читать её будет абсолютно неподготовленный человек. Поэтому любые потенциально опасные действия должны сопровождаться предупреждением. Например:
sudo rm -rf directory
Данная команда должна быть выполнена в точности так, как приведено в этом руководстве. Будучи выполнена иначе, в другом каталоге или с ошибками в наборе, эта команда может удалить любые данные с вашего компьютера!
Нетривиальные действия
Если где-то в статье вы предлагаете пользователю выполнить какие-то действия, специфичные для Ubuntu и Linux в целом, то не стоит полагаться на его эрудицию. Любая нетривиальная операция должна сопровождаться ссылкой на статью по этому поводу, либо, на крайний случай, кратким описанием. Например:
… необходимо перезапустить X-сервер …
Данный пример наглядно показывает преимущества ссылок вместо описания действия в текущей статье, потому как в подсказке не описаны ни побочные эффекты, возникающие при перезапуске Х-сервера (которые, согласно пункту «Потенциально опасные действия» данного руководства, должны быть описаны), ни неприменимость данного решения для Ubuntu 9.04.
Дополнения, примечания, советы и подсказки
Небольшие дополнения и пояснения, относящиеся к различным пунктам статьи, всячески приветствуются. Например:
Однако не забывайте, что статья должна быть как можно более лёгкой к усвоению, поэтому не замусоривайте её ненужной информацией. В любом случае лучше дать ссылку на статью, в которой обсуждается та или иная проблема, чем вставлять пусть даже краткое обсуждение напрямую в свою статью.
Стандартные операции
Если вы просите пользователя выполнить некоторые стандартные операции, то обязательно давайте ссылку на статью, в которой описываются подобные действия.
Установка пакетов
Редактирование текстовых файлов
Ссылки на другие ресурсы
Если вы используете в сатье технические термины и узкоспециальные понятия, то хорошо бы давать ссылки на энциклопедические ресурсы, в которых они описываются. В качестве основного подобного ресурса можно использовать Википедию. Однако категорически запрещено вставлять ссылки на непроверенные ресурсы, ресурсы, изобилующие рекламой, так же нежелательны ссылки на сайты с документацией других дистрибутивов Linux.
Подписи и авторство статей
Во первых, хочется сказать, что наш ресурс является WiKi ресурсом, и поэтому подразумевается совместная работа над статьями. Следовательно, если вы написали некую статью и поставили под ней свою подпись, вы присваиваете себе авторство и возможных дальнейших правок этой статьи, сделанных другими пользователями. Согласитесь, это не очень красиво. Конечно, в дальнейшем кто-то может просто убрать вашу подпись1), но все равно, это слабо соответствует концепции WiKi. Во-вторых, если вы все таки хотите подписаться под статьей, оставляйте, пожалуйста, ссылку на свой профиль на форуме. Это сразу предоставит желающим несколько различных способов связаться с вами (при правильно заполненном профиле), в том числе при помощи личных сообщений на форуме.