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

Andriy Dobrovol's'kii dobr на iop.kiev.ua
Чт Мар 31 19:40:37 MSD 2005


Kirill Maslinsky wrote:
> Всем добрый день!
> 
> Ниже -- черновик оглавления руководства по эксплуатации к выходящему 
> вскоре Compact 3.0. Помимо этого руководства предполагается ещё 
> отдельное руководство по установке. 
> 
Почитав это письмо и обсуждение, прихожу к выводу, что снова "телегу 
впрягают впереди лошади". До составления оглавления, ИМХО, нужно 
четко определить комплектацию выпуска и его целевую аудиторию. От 
этого зависит о чём и как писать...
Пока, такого определения что-то не видать.
> Руководство по эксплуатации будет только в электронном виде, 
> по установке -- в электронном и бумажном.
> (возможно, какие-то отдельные части Рук-ва по эксплуатации следует также
> включить в печатную документацию -- обсуждаемо).
> 
В бумажном руководстве обязательно нужно внятные описания по 
настройке железа. В смысле "куда бежать" в случае проблем с 
конкретными типами железок. В особенности это касается возможных 
проблем с видео. И не должно быть привязок к установленности 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
*********************************************************************


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