[docs] Категоризация

Kirill Maslinsky kirill на altlinux.ru
Вт Янв 25 23:26:33 MSK 2005


> > 1. Область применения ПО 
> > ========================
> > 
> > * Рабочее место (один компьютер)
> > * Сервер (один компьютер)
> > * Офис (много комьпютеров)
> 	Если статья не про ПО?
Я исходил из задач проекта, где указана документация про ПО и решения.
Но ты прав.

> Про регулярные выражения, про безопасность, про community, про лицензии,
> про хакерскую этику, про Сизиф, про проект ALD? Эта группа категорий не
> вполне универсальна, да к тому же косвенна. Напоминаю, что
> классифицируем мы тексты, а не ПО. На худой конец -- "Решения на базе
> Сизифа".
Регулярные выражения с некоторой натяжкой относятся в Рабочее место (т. к. 
это операционная среда),  безопасность -- тоже, а ещё может и в Сервер и Офис,
смотря по безопасности. Остальное, да, не входит, но для таких я предлагал 
``Везде''.

 
> > 2. Уровень изложения
> > ====================
> > 
> Предлагаю просто ввести три уровня изложения
> 
> * Начальный ([prerequisit=[])
> * Пользовательский ([prerequisit=базовые знания в _определённом_ предмете])
> * Профессиональный ([prerequisit=серьёзные познания в предмете])
> Обращаю ваше внимание, что такое разделение не затрагивает, о каком
> предмете идёт речь. Следовательно, эта группа категорий универсальна.
Поддерживаю. Только не согласен, что уровень определяется prerequisit'ами.
Не совсем так: документ может (и должен, в идеале) объяснять всё с азов. 
Профессиональность изложения состоит скорее в том, какие тонкости излагаются.
Т. е. насколько глубоко должен пользователь разобраться в предмете, если он
внимательно прочтёт текст. Напомню, что можно указывать несколько уровней. 
Тогда в ``идеальном'' документе будут присутствовать все от начального, а 
в других, возможно, только пользовательский или профессиональный (или даже оба, но без начального -- всё вполне реалистичные типы документов).

> * ALT
> 	Если в их тексте _встречается_ что-то специфичное. Например,
> статья может быть про CUPS, но в ней, в числе прочего, говорится и про
> noizvrat=YES.
Это я и имел в виду, неточно сформулировал.

> 	Этот пункт одобряю, так как он устроен в любимом мною жанре
> дихотомичности.
Столь любимые программистами привативные оппозиции стаканов ;)

> 	Слишком пристально. На этом уровне возможно ввести ещё гору
> жанров, и ещё много останется необхваченным. Хотя идея жанра мне
> нравится, надо только на уровень выше подняться.
А мне идея жанров не нравится. Но готов смириться, потому что это то, 
что без колебаний укажет Автор в паспорте. Если не даст сомнению пустить 
в себе корни.

> Например, так:
> * Справочная информация (только сведения)
> * Учебная литература ([неполные] сведения с методическими замашками)
> * Общественно значимые тексты (полиси, реклама, анонсы, тексты _про_
>   всякий социум)
Назвать бы их иначе. Попонятнее.
> * <Catch-all> Занимательное чтение
Не очень мне нравится такая классификация, потому что слишком общие 
названия жанров. Тексты чисто таких жанров в природе не существуют
(или редки), названия жанров искусственные, так что Автору придётся 
поломать голову, куда отнести текст и эвристические операции в его 
мозгу на эту тему непредсказуемы. Поэтому названное мною преимущество 
(очевидность классификации для ``наивного носителя'') пропадает полностью. 
Уж лучше в этом случае жанр вовсе не указывать, а то все окажутся в занимательном чтении.

> 	Учитывая специфику Сизифа, как хранилища именно ПО и ALD, как
> проекта документирования "Решений" (чем бы они ни были), первые две
> группы Кирилла можно попробовать объединить так:
> 
> * Использование (ПО на любом уровне, от "кнопки" до шаманства, "Решения"
>   сюда тоже входят, howto тоже)
> * Разработка (в основном, ПО, но не только, вообще deployment, приёмы
>   программирования, то есть всё про "создание")
Не против. А в какую категорию их? Или отдельно?

> Итого уже десять пунктов. Видимо, можно "использование" побить на
> подпункты (на какие? +администрирование? +полезные советы? не знаю
> пока), и добавить в этот список правильно сформулированный Catch-all.
Заменить словом применение и не бить на подпункты. И стоило ли отказываться
от Рабочего места/Сервера/Офиса?

> BTW, "ключевые слова" входят в наш "минимальный формат", так что
> возможность поиска по ним будет автоматом -- только не для Кучи, а для
> готовых модулей. Но для Кучи ведь этого и не нужно.

Это в наш с тобой минимальный формат входят ключевые слова, в ADT мы пока 
их не предлагали и не обсуждали.

-- 
Kirill Maslinsky
ALT Linux Documentation Team



Подробная информация о списке рассылки docs