[docs] Re: wiki

[Vitaly Ostanin]

On Mon, 25 Nov 2002 23:02:29 +0300
Alexandre Prokoudine <avp на altlinux.ru> wrote:

> On Mon, 25 Nov 2002 22:59:07 +0300
> Alexandre Prokoudine <avp на altlinux.ru> wrote:
> 
> > www.lrn.ru/~avp/wiki
> > 
> > Книга жалоб и предложений - docs на altlinux.ru
> 
> Сразу отмечу, что меня интересуют не битые ссылки, о которых я
> и так знаю :-). а сам принцип построения и наполнения.

Принцип построения по html-выводу смотреть неудобно.

В названии можно было бы честно написать, что это FAQ :)

Вопросы не пронумерованы, неудобно ссылаться. 

На
http://lrn.ru/~avp/wiki/pt02.html
в ответе из 3-й пары непонятно, зачем нужен 4-й шаг (с iconv).

Там же пример длинной команды с параметрами лучше оформлять не
command, а example.

Там же избыточные (IMHO) личные обращения. Вообще непонятно,
зачем в тех. документации личные обращения.

Странно, что этот документ и стили, на которые он ссылается,
лежат в разных местах, а не на docs.altlinux.ru

Странно, что
http://lrn.ru/~avp/wiki/pt03.html
отчасти дублирует
http://docs.altlinux.ru/alt/devel/ar01s08.html

Вообще весь этот документ неплохо бы интегрировать в cvs docs,
общую структуру документов (alt/devel), и как-то совместить в
docs-howto. Сейчас наличие двух разных документов лично мне
напоминает ведение параллельной ветки.

Также не уверен в том, что такие описания нужно делать в виде
FAQ - некоторые вопросы должны содержать не просто набор шагов, а
полное объяснение, почему так делается и зачем.

Всё сказанное сказано не ради критики, не надо обижаться :)

<skipped/>

-- 
Regards, Vyt
mailto:  vyt на vzljot.ru
JID:     vyt на vzljot.ru
----------- следущая часть -----------
Было удалено вложение не в текстовом формате...
Имя     : отсутствует
Тип     : application/pgp-signature
Размер  : 189 байтов
Описание: отсутствует
Url     : /pipermail/docs/attachments/20021125/686d189b/attachment.bin