[docs] docs plans

Anton Farygin rider на altlinux.com
Чт Дек 25 19:12:23 MSK 2003


Michael Shigorin wrote:
> On Wed, Dec 24, 2003 at 04:33:09PM +0300, Alexandre Prokoudine wrote:
> 
>>Антон предлагает писать документацию так, чтобы она не была
>>завязана на конкретное приложение.
> 
> 
> Это хорошо, но расходится с "эффективным применением" и "справкой
> по аргументам".  В принципе.
> 
> 2 rider: если ты _это_ имел в виду -- догадаться было невозможно.

Нет.

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

В данный момент это - coreutils, bash, XFree и т.д.

  Я надеюсь, что список можно будет составить и он будет достаточно 
большой, что бы его пришлось урезать.

Есть части дистрибутива, которые пока не готовы и как они будут 
реализованы - скорее всего не знают даже разработчики этих частей.

В частности это - инсталятор и средства настройки. Также пока еще не 
совсем опрелены алгоритмы работы (настройки, детекта и т.д.) с 
оборудованием. Но это как раз можно пока отложить.

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

> 
> 
>>Однако, таким образом мы получим документацию алгоритма, т.е.
>>чистую теорию вместо практики, в то время как решение задач
>>подразумевает в гораздо большей степени практику.  Разумность
>>такого подхода представляется мне сомнительной.
> 
> 
> Это раз.  И два -- он подразумевает универсализацию, а это
> процесс сложный и дорогой.
> 
> 
>>Программы должны быть документированы в первую очередь сами по
>>себе теми, кто в этом заинтересован. Ресурсов ALT на всеобщее
>>документирование не хватит никогда.
> 
> 
> Именно.  И тратить силы на дублирование -- самоубийство.

Нет. Самоубийтво предоставлять неполноценную, не связанную и 
разрозненную документацию.

Rgds,
Rider




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