[docs] Категоризация
Kirill Maslinsky
kirill на altlinux.ru
Вт Янв 25 12:37:50 MSK 2005
Всем добрый день.
По результату некоторых практических опытов классификации имеющейся
документации сложился проект списка категорий для ``Кучи''.
Классификация очень короткая, в 3 признака:
1. Область применения ПО
========================
* Рабочее место (один компьютер)
* Сервер (один компьютер)
* Офис (много комьпютеров)
Комментарии:
Категория ``Офис'' подразумевает, что в тексте, грубо говоря, описывается
настройка нескольких хостов, т. е. не только серверной, но и клиентской
части -- как единого решения. Пример документа, подходящего для этой
категории, -- ``Организайция корпоративной сети''
Некоторые вводные тексты настолько общие, что отнятся ко всем трём
перечисленным категориям (например, ``что такое Linux''). Для таких
можно либо вообще не указывать значение по этой категории, либо ввести
специальное значение ``Везде''.
Если текст подходит сразу к нескольким категориям, возможно
2 варианта:
Вариант 1.
Указывать в паспорте текста сразу несколько значений.
В этом варианте не имеет смысла категория ``Везде''.
Вариант 2.
Указывать в паспорте текста только одно значение, подразумевая,
что категории ``концентрически'' включают друг друга.
Т. е. установив ``Сервер'' подразумеваем ``Сервер и Рабочее место''
Категория ``Офис'', соответственно, ``Офис, сервер и рабочее место''.
Без категории ``Везде'' и в этом варианте легко обойтись.
2. Уровень изложения
====================
* Введение
Объяснение, что как и для чего, объяснение терминов и т. п.
* Использование
Описание, на какие ``кнопки'' нажимать пользователю,
с примерами и конкретными названиями ``кнопок''.
* Настройка
Объяснение, как ПО приспособить для своей задачи,
с примерами конфигов.
* Разработка
Объяснение, как сделать своё ПО, сюда относятся полиси по сборке
пакетов и пр. Сюда не относится руководство по использованию ПО
для разработки, например, CVS.
3. ALT
======
В этой категории одно только значение -- ALT.
Нужно его ставить в паспорте всех документов, описывающих что-то,
специфичное для ALT.
Вот и вся классификация. Сюда можно добавить признак ``жанр текста'',
хотя он и не особенно полезен для собственно классификации документов,
но может что-то говорить об их характере. Список возможных жанров:
Статья
Учебник
Книжка
Справочник
Howto
FAQ
Policy
Реклама/Объявление
Если вводить в классификацию тематические рубрики, например,
``Оборудование'', ``Электронная почта'' то может повыситься
эффективность поиска по ``куче'', но вот этих-то категорий
точно нельзя придумать заранее и немного. И их список
будет непременно пополняться.
Вопросы, замечания, предложения?
--
Kirill Maslinsky
ALT Linux Documentation Team
Подробная информация о списке рассылки docs