Gentoo Linux Wiki:Style Guide

Материал из Gentoo Linux Wiki

Официальные страницы TOC

Помощь FAQ Описание Стилей Справка по редактированию Как назвать статью Запросить статью Викификация Сайт О сайте Список админов Листы рассылки Обсуждение на IRC Backups Авторские права

Статьи на Gentoo Wiki - это преимущественно описания "howto/как сделать", содержащие инструкции по установке, настройке и пользованию программами и оборудованием.

Содержание 1 Языковой стиль 2 Стиль Страницы 3 Формат статей 3.1 Статьи по оборудованию 4 Обсуждения 5 Заголовки 6 Категории

[править] Языковой стиль

Статьи должны быть на правильном Русском языке, по возможности избегая технической терминологии. Технические термины должны содержать определения (прямые или непрямые ссылки на страницы описаний значения).

Статьи должны быть написаны от третьего лица. В смысле избегайте использования "Я" или "Мы". Вместо этого обращайтесь к читателю и используйте Вы, Ваш.

[править] Стиль Страницы

Страницы должны быть простыми, с использованием разметки. Цель wiki - это предоставить инструкции, а не выглядеть красиво. Изображения не должны использоватся в качестве украшения, или для стилистических целей.

[править] Формат статей

Статьи должны содержать нижеприведенные разделы по порядку:

• В первых строках обозначьте ссылки на такую же статью на другом языке. К примеру текущая статья в первой строке содержит [[en:Gentoo Linux Wiki:Style Guide]] данная ссылка создает линк в навигационной панели внизу слева (на английскую статью в данном случае). В дальнейшем, наш робот сможет перелинковать статьи внутри wiki для обозначения языков, на которые данная статья переведена.
• Вначале напишите обобщение статьи.
• Обозначте что в результате будет достигнуто и что необходимо подготовить перед началом (знания, программы). Вы можете, если хотите, обозначить дополнительные темы которые хорошо бы знать, и ссылки где можно пополнить свой багаж знаний.
• Проведите читателя через весь процесс, по шагам, объясняя что делают команды.
• Обозначте секцию для нахождения неполадок с описанием часто возникающих проблем и/или ошибок и как их поправить.
• Оставьте дополнительные ссылки на подходящие статьи по теме, включая статьи с других сайтов.
• Еще раз убедитесь что вы использовали подходящие шаблоны

[править] Статьи по оборудованию

Статьи содержащие описание оборудования должны содержать следующую информацию:

• В подходящих местах, результат команды

или

относящийся к оборудованию

• Дополнительные имена, которые могут быть использованы для обозначения устройства. Не используйте все устройства (к примеру лэптоп, беспроводные устройства) в которых может быть использовано данное оборудование (к примеру: звуковые карты, wifi карточки)

[править] Обсуждения

Любые обсуждения должны происходить на странице обсуждения, но не в самой статье.

[править] Заголовки

Заголовки используются как стандартное соглашение в MediaWiki и начинаются как == а не как =.

[править] Категории

Категории ([[Category:Foo]]) должны быть использованы в конце страницы. Любая статья должна принадлежать хотя бы к одной категории.