[docs] схема документации на desktop4.0

Artem Zolochevskiy artem.zolochevskiy на gmail.com
Вт Июл 3 11:10:42 MSD 2007


hi all

Вот какой в целом мне видится документация на Desktop4.0

Desktop 4.0
-----------
Итак.
Господин X держит в руках DVD с Desktop 4.0
Какие вопросы будут его интересовать.
Вероятно, прежде всего -- как это установить?
Ну а после установки, видимо, -- и что дальше с этим делать?

Значит главная задача прилагаемой документации сводится именно к ответам на 
эти два вопроса.

1. как установить
2. и что дальше?

установить
----------
* Разъяснения того, а что же господин X держит в руках. Хоть можно и 
предположить, что раз уж он это держит, то примерно знает, что это такое. Но 
всё же, уточним для снятия всякого рода недопониманий.

	СТАТУС: реализовано.
	МОДУЛИ ДОКУМЕНТАЦИИ:
	-whatis_linux.kirill
	-whatis_alt.kirill
	-whatis_desktop4.0.azol

* Руководство должно охватить всё, то необходимое для того, чтоб человек 
оказался перед
"рабочим столом". К сожалению, в описании процедуры установки не обойтись без 
лирических отступлений. Особенно на тему "разбивка диска". Естественно 
предупреждаем и о резервном копировании.
	
	СТАТУС: реализовано (нужно просто следить за актуальностью модулей)
	МОДУЛИ ДОКУМЕНТАЦИИ:
	-backup_before_install.kirill
	
	-hd_planning.kirill
	-alterator_vm.kirill
	-hd_naming.kirill
	-hd_structure.kirill
	-linux_filesystem.kirill
	-linux_fstypes.kirill

	-install0.kirill
	-install2.kirill
	-alterator_users.kirill
	-alterator_apt.kirill
	-alterator_network.kirill
	-alterator_timezone.kirill
	-alterator_x11.kirill
	-install_finish.kirill

Здесь, в принципе всё. Господин X должен уже сидеть абсолютно счастливый за 
свежеустановленным Desktop 4.0 :-)
То, что ниже, -- это уже начало ответа на вопрос "и что дальше?".

* Описание "Центра управления системы (web)" и "Центра управления системы" 
как "официального" способа конфигурации. Указываем и на "ручной" способ.
Обязательно описание системы установки дополнительного ПО.
Обязательно включение модуля документации linux_basics.kiril, где речь о 
включении/выключении компьютера, текстовом/графическом режимах и пр.
Обязательно включение модуля документации documentation_alt.kirill, где речь о 
man/apropos/whatis/info//usr/share/doc//где в меню ссылки на ALT-документацию
	
	СТАТУС: реализовано частично
	МОДУЛИ ДОКУМЕНТАЦИИ:
	-smc.azol
	-/var/www/html/fbi/help/ru_RU/alterator.html
	-manual_config.azol

	-packages_apt.kirill
	-packages_synaptic.azol

	-linux_basics.kiril
	-documentation_alt.kirill

В принципе этого должно быть достаточно для старта. Но так, как надеяться на 
то, что пользователь после установки и прочтения documentation_alt.kirill 
смело пойдёт решать свои постустановочные задачи чтением man/info итп не 
приходится, то добавляем ещё и

* "быстрый старт" для часто возникающих задач.
	
	СТАТУС: не реализовано
	МОДУЛИ ДОКУМЕНТАЦИИ:
	-quickstart.azol

Все вышеуказанное и должно составлять печатный DVD буклет. Т.е это -- та база 
с которой можно начать осмысленно работать.

и что дальше?
-------------
Начальный толчок дан в linux_basics.kiril + documentation_alt.kirill 
+ "быстрый старт" печатного буклета.

Остальной объём документации -- в эл. виде.
Ссылку на документацию -- на самом видном месте (раб столе/меню/упоминание в 
печатном буклете)

Эл. документация -- два раздела (к примеру таблица в два столбца)
* эл. собрат печатного буклета
* прочая доступная в виде модулей документация, наличие, которой имеет смысл в 
desktop.

Теперь мысли о "прочей" документации. Что у нас вообще есть?
Есть наработанный материал (гора модулей документации)
следует отсортировать этот список на предмет
1. принципиальной применимости к Desktop
Эта попытка сделана мной здесь: 
http://lists.altlinux.org/pipermail/docs/2007-June/006433.html
2. целесообразности наличия конкретного модуля
тут можно различать варианты 4.0. К примеру есть модули отлично подходящие 
для "образовательного" дистрибутива, но не думаю, что нужны для просто 
DVD-версии - 
3. решить вопрос о модулях, дублирующих содержание справочной информации. К 
примеру dialup_short.kirill по сути пересказ KDE-документации на kppp.
4. выявить важные области использования desktop непокрытые имеющимися модулями 
документации и создать эти модули.
Вот тут надо сильно думать. Что включать? Что дописывать? Где будет достаточно 
отослать из "быстрого старта" на официальную документацию по тому или иному 
ПО.

Ясно что в этой "дополнительной" части должны быть модули, отсутствующие в 
печатном руководстве, но на которые в нём есть ссылки:
	-Saga_of_Devices.george
	-wine_intro.kirill
	-linux_apps.kirill

Историческо-идеологический раздел, думаю, тоже нужен
	-freesoft_history.kirill
	-linux_history.kirill
	-free_and_open_source.kirill

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

Как всегда комментарии предложения приветствуются.

-- 
Артём Золочевский


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