[docs] Категоризация
Kirill Maslinsky
kirill на altlinux.ru
Чт Янв 27 12:20:34 MSK 2005
Всем привет!
> От общей классификации не уйти, потому что необщая подразумевает десятки
> пунктов. Предлагаю тогда классификацию АЕН:
> * How (всё, что без объяснений: howto, инструкции, cookbook, таблички с
> командами и прочее)
> * How & Why (всё, что с объяснениями: FAQ, руководства, учебники,
> методички, описания и прочее)
> * "Why" (любые заявления, не касающиеся технических вопросов, или список
> требований к чему-то: полиси, реклама, анонсы, тексты _про_ сообщество
> и прочая идеология и т. п.)
> * <Catch-all> Занимательное чтение
Я против catch-all: пусть лучше по прочтении текста будет не очень понятно,
почему он попал в ту или иную категорию, чем вообще непонятно, что это
за текст и браться ли его читать. (Эпитет ``занимательное'' скептическому
уму может обоснованно показаться субъективным и потому неубедительным).
> Надо категории переназвать, а то слишком поэтично, но идея понятна?
Идея понятна, хотя есть опасения, что бОльшая часть текстов попадёт в
How&Why, потому что так чтобы совсем без объяснений -- бывает редко.
Хотя это, наверное, и хорошо. Что касается названий...
Моя жена предложила такие:
* Инструкции (how)
* Индукции (от частного к общему: учебники, tutorials, и т. п. обучающие тексты)
* Дедукции (от общего к частному: why&how, как обычно и бывает в хорошей документации)
Очень изящно, по-моему.
> Может, и в самом деле стоит поделить на рабочее место/сервер (он же и
> офис, так как области задач примерно одинаковые). Или так, по источнику
> задач:
Офис в отдельный пункт я выделил, чтобы туда попали тексты, про то как сделать именно офис на линуксе, т. е. и серверы, и рабочие места, корпоративная сеть, словом. Конечно, в выделении офиса в отдельную категорию есть толика PR-а.
> * Для себя (про рабочее место, маленькие хитрости и т. п., игры)
> * Для фирмы (когда задачи ставит начальство: административные дела,
> серверы, сеть)
Минус классификации по источнику целей: одна и та же цель (например, организация smtp-сервера или списка рассылки и т. п.) может иметь источники самого разного характера. А как сделать -- один текст.
Предлагаю всё-таки не лоамться и согласиться на рабочее место/сервер с
пояснениями, что имеется в виду и примерами, какие темы подходят.
> * Для сообщества (чуть не забыл! у нас же проект основан на Сизифе! И
> вот категория для разработчиком всех мастей, от программистов до
> deployment manager-ов, сюда же всякие FR и прочее)
Это правильно.
Итого, получается:
Область применения
* Рабочее место
* Сервер
* Сообщество
Способ изложения
* Инструкции
* Индукции
* Дедукции
* ALT (содержит ALT-специфику)
Итого 3 признака, 7 категорий -- мечта!
Жду возражений, дополнений -- и в полиси.
--
Kirill Maslinsky
ALT Linux Documentation Team
Подробная информация о списке рассылки docs