[docs] Проект оглавления Руководства по эксплуатации Compact 3.0

[Andriy Dobrovol's'kii]

Kirill Maslinsky wrote:
> Привет!
> 
> 
>>>Ниже -- черновик оглавления руководства по эксплуатации к выходящему 
>>>вскоре Compact 3.0. Помимо этого руководства предполагается ещё 
>>>отдельное руководство по установке. 
>>>
>>
>>Почитав это письмо и обсуждение, прихожу к выводу, что снова "телегу 
>>впрягают впереди лошади". До составления оглавления, ИМХО, нужно 
>>четко определить комплектацию выпуска и его целевую аудиторию. От 
>>этого зависит о чём и как писать...
> 
> Целевая аудитория -- OEM-пользователи.
> У выпускающих дистрибутив есть некоторое представление о комплектации, я
> на него ориентировался при составлении оглавления; публичное обсуждение 
> задач выпуска бывало в devel@ и, наверное, ещё где-то.
> 
Обсуждения, это одно, а окончательные и четкие формулировки -- 
совсем другое. Если целевая аудитория -- ОЕМ, то у них и нужно 
спросить, что они хотят видеть в печатной документации. Если, 
конечно, нет желания поработать ради работы...
> 
>>В бумажном руководстве обязательно нужно внятные описания по 
>>настройке железа. В смысле "куда бежать" в случае проблем с 
>>конкретными типами железок. В особенности это касается возможных 
>>проблем с видео. И не должно быть привязок к установленности Windows.
> 
> А куда бежать -- в поддержку? Тогда это раздел ``поддержка''. 
> Или в магазин за другим, подходящим оборудованием? ;)
>
"Куда бежать" -- т.е. к каким первоисточникам обращаться, чтоб 
заработало. И в каких файлах править, если уже знаешь Что.

> 
>>>Предлагаю для электронного руководства следующую структуру:
>>>
>>>Два больших раздела: 
>>>	- Кратко и по существу
>>>	- Подробности
>>>
>>
>>Очень трудно реализуемо. Я бы делил на "инструкции"(КакСде)
>>и "теорию". Где теория -- всё, что не инструкция.
>>И всю "теорию" в электронную форму.
> 
> Я именно это и имел в виду, просто назвал иначе.
> Чистые инструкции, равно как и чистая теория, практически не встречаются
> в жизни. Обычно они смешаны, с преобладанием того или другого. 
> 
Понятно. С моей точки зрения, "Инструкции" -- не "глубже" 
мини-КакСде. Остальное в теорию. :)

-- 
Rgrds,
Andriy
*********************************************************************
email: dobr at iop dot kiev dot ua            Kyiv, Ukraine
Phone: (380-44)   265-7824            Department of Gas Electronics
Fax:   (380-44)   265-2329             Institute of Physics of NASU
*********************************************************************