Руководство по стилю
Материал из wiki.helpdesk.by
Статьи на http://wiki.helpdesk.by - это преимущественно описания "howto/как сделать", содержащие инструкции по установке, настройке и пользованию программами и оборудованием.
Содержание |
Языковой стиль
- Статьи должны быть на правильном Русском языке, по возможности избегая технической терминологии. Технические термины должны содежать определения (прямые или непрямые ссылки на страницы описаний значения).
- Статьи должны быть написаны от третьего лица. Избегайте использования "Я" или "Мы". Вместо этого обращайтесь к читателю и используйте Вы, Ваш.
Стиль Страницы
- Страницы должны быть простыми, с использованием разметки. Цель wiki - это предоставить инструкции, а не выглядеть красиво. Изображения не должны использоватся в качестве украшения, или для стилистических целей.
- Делайте небольшие страницы. 10 экранных страниц для статьи это слишком даже для очень интересных статей. 2-3 экрана это максимум. Большие страницы лучше разбить на несколько и связать гипертекстовыми ссылками.
- Создавайте страницы структурными. Используйте разделы, подразделы, абзацы, разделители, списки. Структурный текст лучше воспринимается и в нем легче найти необходимую информацию. Самое важное должно быть выделено. Не злоупотребляйте выделением - когда выделено все, значит ничто не выделено.
Формат статей
Статьи должны содержать нижеприведенные разделы по порядку:
- Вначале напишите обобщение статьи.
- Обозначте что в результате будет достигнуто и что необходимо подготовить перед началом (знания, программы). Вы можете, если хотите, обозначить дополнительные темы которые хорошо бы знать, и ссылки где можно пополнить свой багаж знаний.
- Проведите читателя через весь процесс, по шагам, объясняя что делают команды.
- Обозначте секцию для нахождения неполадок с описанием часто возникающих проблем и/или ошибок и как их поправить.
- Оставьте дополнительные ссылки на подходящие статьи по теме, включая статьи с других сайтов.
- Еще раз убедитесь что вы использовали подходящие шаблоны
Статьи по оборудованию
Статьи содержащие описание оборудования должны содержать следующую информацию:
- В подходящих местах, результат команды
или
относящийся к оборудованию
Избегайте использования наименований котрые могут иметь несколько вариантов реализации. Будьте максимально конкретны в определениях.
Обсуждения
Любые обсуждения должны происходить на странице обсуждения, но не в самой статье.
Заголовки
Заголовки используются как стандартное соглашение в MediaWiki и начинаются как == а не как =.
Категории
Категории ([[Category:Foo]]) должны быть использованы в конце страницы. Любая статья должна принадлежать хотя бы к одной категории.
