[docs] Категоризация
Fr. Br. George
george на altlinux.ru
Сб Янв 29 19:07:06 MSK 2005
On Fri, Jan 28, 2005 at 02:48:55PM +0300, Kirill Maslinsky wrote:
> Всем привет!
>
> > Мой вариант. Предполагается, что аргументы переписывать не надо. А вот в
> > полиси стоит включить по каждой категории предложение-два, объясняющее
> > её суть, так как категории достаточно общие.
> Отлично, в целом согласен, минимум комментариев см. ниже.
> >
> > Уровень изложения
> Скорее это стили, или даже Способы изложения. Заменить название категории?
"Уровень", мне кажется, понятнее: "стили" и "способы" имеют слишком
много различных толкований, а по слову уровень можно уже сразу
догадаться, что имеется в виду под "тремя уровнями изложения".
> > * Научно-популярный
> > * Пользовательский
> > * Профессиональный
> >
> > Тип документа
> Вот здесь нужны бы твои пояснения в два предложения в свободном стиле
> к каждому пункту, чтобы я тебя правильно понял и адекватно отразил в полиси.
Мда, я слегка перешутил с двойными названиями. Лучше уж
одинарные.
> > * Инструкция
Документы в стиле "How", предназначенные для оперативного или
неквалифицированного снятия проблем (без объяснений или с объяснением,
куда пойти и что почитать)
- тренинг и справочники в стиле "проблема -- решение" (например,
руководство оператора или секретарши)
- разовые или пошаговые действия (напр., руководство по установке)
- оперативные ответы на вопросы (HOWTO)
- пямятки, шпаргалки, сводные таблицы и т. п.
- . . .
> > * Документация (взял на себя смелость переименовать)
Документы в стиле "How&Why" (порядок любой, но оба поля должны
наличествовать:), предназначенные для того, чтобы раз и навсегда
объяснить читателю, в чём дело, и чтобы он глупых вопросов больше не
задавал
- методички (это близко к "How", но пользователь должен уйти с
чувством, что всё понял:)
- Примеры решения хитрых или, наоборот, типовых задач хитрыми
инструментами (нечто среднее между предыдущим и следующим
пунктом)
- ответы на вопросы "почему" (т. е. FAQ, здесь я разделяю FAQ и
HOWTO, но в реальности, видимо, их придётся отнести к "How")
- учебники
- . . .
> > * Декларация
Документ в стиле "Why" или "What", то есть описывающий что-то без цели
научить, разве только поставить в известность или убедить
- полиси и правила
- форматы
- реклама, демонстрации, презентации
- (возможно, это тоже сюда) ИдИология: ОупенСоурц, Коммьюнити и
прочее. Потому что "убедить"
> > * <catch-all>Публикация
- Всё, что нам показалось достойным ALD, но непонятно, почему :).
> >
> > Тип решения
> > * Персональное
> > * Сервисное
> > * Общественное
> >
> > Специфичность
> > * ALT-specific
> > * UNIX/POSIX-specific
Может, добавить ещё
* Многоплатформенный (пускай не-UNIX-оиды порадуются)
?
> Последние технические вопросы для публики:
>
> 1. На каком языке должны быть названия категорий:
> - на английском как стандартном
Это, конечно, будет короче, но мы так старались выдумать
_правильные_, говорящие за себя названия...
> - на русском как нашем
Думаю, так.
> - на всех употребляемых с приложением таблицы соответствий
Это потом, когда припрёт на английский переводить.
> - вообще не надо названий, а в паспорте ставить цифры или условные знаки
Нет, групп будет не так уж много: автор просто откроем
WWW-страницу со списком и скопирует нужные.
>
> 2. Формат для поля с классификацией
> Напомню, для классификации документа в паспорте отведено поле
> Section:. Как оформлять там список нужных категорий?
> - через "," или другой разделитель, списком, в любом порядке
> - как-нибудь иначе
Мне кажется, у некоторых может не влезть в строку. Поэтому предлагаю
поле Subject: в паспорте повторять столько раз, сколько захочется. При
эом внутри Subject может быть только одна категория.
Или можно разрешить и несколько, через ";".
>
> 3. Обязательность признаков:
> Обязательно ли указывать какую-нибудь категорию по каждому из признаков?
> - обязательно
> - необязательно
> - обязательно для некоторых категорий, для остальных -- необязательно
Хотелось бы, чтобы "Обязательно". Но, боюсь, не получится. "Желательно" :).
Напоминаю, что текст может принадлежать к нескольким категориям одного
признака. Например, в тексте про OOo _модержится_ что-то ALT-specific =>
он и "ALT" и "Многоплатформенный". То же самое относится и к твоей идее
о том, что хорошая книжка -- одновременно и научно-популярная, и
профессиональная. Так, к сожалению, бывает крайне редко, но если уж
случилось... В общем, на добавление Section ограничений нет.
--
George V Kouryachy (aka Fr. Br. George)
mailto:george at altlinux_ru
Подробная информация о списке рассылки docs