[docs] Re: документация для нового Junior'а

Kirill Maslinsky kirill на altlinux.ru
Вс Фев 1 18:35:34 MSK 2004


Всем привет!

<skipped/>

> Мне больше нравится этот вариант:
> <systemitem class="resource">xml-utils-2.5.10-alt1</sistemitem>.
> 
> В детальности разметки должен быть и предел :)

По-моему, детальность разметки должна определяться задачами документа.
Если из этого исходить, то такая сущность, как имя пакета, причем 
преимущественно в форме xml-utils, -- это вещь, во-первых, очень
частотная, во-вторых, очень важная для пользователя, поскольку именно 
пакет для него -- единица функциональности системы. Особенно если он 
не получает установку, работающую из коробки, или хочет что-то
удалить-установить сам, или просто даже узнать, что есть в системе. 
Поэтому очень хочется иметь отдельный способ разметки именно для 
сокращенного имени пакета (в той форме, в какой с ним работает apt),
к тому же это позволит выделять его особым образом в тексте, если будет 
такая оформительская идея. Сейчас этого не сделано, но может быть и
нужно. Кроме того, хотелось бы когда-нибудь сделать указатель пакетов, 
а для его построения, насколько я понимаю, понадобится, чтобы пакет был
самостоятельным элементом. 

Господа разработчики! Пожалуйста, помните, что для пользователя,
незнакомого с Linux, понятие "пакет" весьма неясно, как и разница 
между программой/командой/пакетом, а слово это встречается везде
и всюду в документации задолго до того, как оно об'ясняется 
(но с этим я поборюсь). Особенно меня беспокоит новый Junior, который
попадет в первую очередь в сельские школы. Поэтому мне кажется
совершенно нелишним завести специальный способ выделения для имени пакета,
отличный от команды.

Что же касается детальности разметки, то мне кажется, что как раз можно 
пренебречь детализацией для вариантов xml-utils-2.5.10-alt1,
xml-utils-2.5.10-alt1.rpm, включив их в filename или resourse.
Потому что в таком виде они в документации не так уж часто встречаются.


> Если потом понадобится перечень пакетов, к которым относится
> документ, это уже отдельная задача.

Честно говоря, не понял, что имеется в виду под "перечнем пакетов, к 
которым относится документ". 

КМ





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