[docs] docs plans

Michael Shigorin mike на osdn.org.ua
Чт Дек 25 22:25:28 MSK 2003


On Thu, Dec 25, 2003 at 07:12:23PM +0300, Anton Farygin wrote:
> >>Антон предлагает писать документацию так, чтобы она не была
> >>завязана на конкретное приложение.
> >Это хорошо, но расходится с "эффективным применением" и
> >"справкой по аргументам".  В принципе.
> >2 rider: если ты _это_ имел в виду -- догадаться было
> >невозможно.
> Нет.  Есть части дистрибутива, которые незыблемы, непоколебимы
> и изменения в которых происходят крайне редко.  В данный момент
> это - coreutils, bash, XFree и т.д.

...и назвал более чем конкретные даже не приложения, а
компоненты.  Микроплатформы, можно сказать.

Понимаешь, я согласен, что хорошее введение в тот же шелл --
нужно.  И очень рад, что его пишут.  Но написать про
*эффективное* применение bash без упоминания башизмов или про zsh
-- без фокуса на _его_ фичах -- это нонсенс.  Эффективность --
это пользование частностями для обобщения, а незавязанность на
конкретное приложение -- это обобщение ценой потери частностей.

Это противоположные вещи. :(

> Я предлагаю документировать фундаментальные вещи, но с учетом
> наших особенностей и вписав их в структуру будущей
> документации.

Еще раз: не надо мух к котлетам.  Фундамент -- это котлеты.  Наши
особенности -- это мухи.  Можно наоборот.  Но не вперемешку.

> >Именно.  И тратить силы на дублирование -- *.
> Нет.

Да.

> * предоставлять неполноценную, не связанную и разрозненную
> документацию.

Да.

-- 
 ---- WBR, Michael Shigorin <mike на altlinux.ru>
  ------ Linux.Kiev http://www.linux.kiev.ua/



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