On Thu, Apr 03, 2008 at 09:37:02AM +0400, Stanislav Ievlev wrote:
> >  > Документация по альтератору ужасающая. Несмотря на обилие
> >  > примеров и цитат кода на scheme, она не даёт ответ на
> >  > вопрос: "Зачем всё это нужно?"
> > Есть предложение не тратить слишком много пороха на текущую
> > архитектуру.
> Думаешь, мы за месяц перепишем всё с нуля? ;)

Нет, не думаю.  Просто можно документировать в стиле HOWTO
-- как сделать одно и не напороться на известное другое;
можно писать более фундаментально, и поскольку люди склонны
бросаться в крайности -- то попытался предупредить именно
"слишком".

> Писать длинные и туманные объяснения "А зачем это нужно",
> "А чем это лучше" точно не надо, а побольше конкретной
> документации не помешает ...

Угу, только скорее "достаточно" и на вики, а не где-либо 
в чугунии.

> другое дело, что тут в devel-conf больше переливаний из пустого
> в порожнего в ожидании когда я доберусь и напишу что-то.

Ты, кстати, довольно неплохо пишешь -- только может быть лучше,
если писать будет Слава с твоих слов (или кто в Питере со слов
кого разобравшегося): будучи автором, легко упустить что-то как
самоочевидное просто на автомате.

Ещё один момент -- обновляя документацию, касающуюся
функциональности конкретного пакета, было бы здорово сразу
в шапке упоминать название и версию, чтоб можно было соотнести
с %changelog, даже если дока устарела. (ещё лучше при этом имя
пакета делать ссылкой на http://sisyphus.ru/srpm/%name/changelog)

> А ведь рядом с Гришей сидит минимум три документатора, вот им
> и флаг в руки ;)

Ну так они напишут пять томов как раз к следующему витку,
этого бы и не хотелось.

Сейчас бы вытоптать грабли в рамках 4.1/branch, заодно фиксируя
то, что плохо поясняется (поскольку делать пришлось в аврал).

-- 
 ---- WBR, Michael Shigorin <[EMAIL PROTECTED]>
  ------ Linux.Kiev http://www.linux.kiev.ua/
_______________________________________________
devel-conf mailing list
[email protected]
https://lists.altlinux.org/mailman/listinfo/devel-conf

Ответить