[docs]Re:документация для нового Junior'а

Kirill Maslinsky kirill на altlinux.ru
Ср Фев 4 19:52:37 MSK 2004


> >драфт пока слишком сырой. как только он станет похож на что-то
> >осмысленное, я его выложу в cvs и сообщу об этом. потому что всякие 
> >подсказки, замеченные опечатки и предложения, что туда еще включить, 
> >очень приветствуются.
> 
> огласите хотя бы оглавление :-) 
> к тому же у меня сейчас нет доступа к cvs, из-за злобного админа - так что могу смотреть только через web

Конечно, сейчас оглашу. Принимаю и ожидаю поправок, дополнений и
соображений.

КМ

----------- следущая часть -----------
В документации предполагаются следующие общие части:

1. Отдельная бумажка или брошюра, предназначенная для первого оператора: 
	пароли root для предустановленных систем и первичные инструкции 
	по сборке, подключению, регистрации пользователей. Координаты 
	поддержки. Чтобы обеспечить работоспособность. 

	Еще предстоит написать, но для этого нужно понимать, как что будет 
	устроено. Кто должен писать этот текст -- пока мне непонятно. 


2. Книга для учителя (нечто вроде методического пособия, заместитель курсов
	повышения квалификации). В силу того, что речь идет о сельском 
	школьном учителе, видимо, приходится сомневаться в степени его 
	знакомства с основами UNIX, поэтому предлагаю включить в эту книгу
	основные понятия с определениями и построить ее как справочник: 
	чтобы из нее легко можно было узнать, что есть в системе, какие 
	программы обеспечивают какую функциональность, и как с этим всем
	работать. Предлагаю включить сюда и методические/идеологические
	пассажи из Отставнова, привесив к описанию соответствующих понятий. 
	Пользовательские описания прикладных программ не включать, а только
	перечислять программы, со ссылками, где про них можно прочитать подробнее.

	По структуре: вижу главную задачу в том, чтобы в каждом разделе 
	вводить последовательно основные термины, следить, чтобы термин нигде 
	не употреблялся до его определения (этого хватает у Оставнова, к сожалению), 
	по возможности устанавливать соответствия между русскими и английскими 
	терминами и приводить возможные варианты перевода. (В сельской школе не 
	знают английского.)

	Идеологическая/методическая часть почти целиком восполняется Отставновым, 
	правда, местами требует довольно серьезной стилистической редактуры. 
	Описание базовых понятий системы у Отставнова не самые удачные, лучше 
	брать из курсов по UNIX или учебника "Прикладная информатика" (еще 
	откуда-то?) А так вообще каждый раздел нужно смотреть. С миру по нитке, 
	видимо.


3. Руководство пользователя. Сюда должны просто войти пользовательские руководства
	по прикладным программам. Потребуется редактура, сверка перекрестных ссылок
	и по возможности унификация терминологии и переводов, или, на крайний случай, 
	примечания от редактора с пояснениями, где разными словами называется одно и 
	то же и перекрестными ссылками. Если будут административные части: 
	например, Samba, системы управления пакетами, установка системы -- тоже, 
	сюда, смотря по об'ёму. Слишком зашкалит об'ём -- можно админитративное вынести
	в отдельный переплет.
	

Подробный план книги для учителя.

Методичка для учителя 
(названия разделов и книги пока условные)

1. От составителя. 
	Этот раздел должен писаться последним, на самом деле. Основные задачи, 
	по-моему, для него такие:
		Открытые системы в школе -- новость. Почему-зачем открытые системы (?). 
		Приводятся базовые сведения, книга построена как справочник.
		Из чего составлена, благодарности авторам.
		Как пользоваться этой книгой: струтктура, справочная информация в конце
		разделов, ссылки на руководство пользователя и другую документацию. 
		Типографские конвенции (как набираются имена команд и т. п.). 
		Какие еще бывают виды документации и как ее найти. Справочный аппарат 
		издания (указатели) -- если будут. Электронная версия документации. 
		Координаты техподдержки.
		

2. Базовые понятия

	2.1 Операционная система
		Определение
		Открытые/альтернативные
		Стандарты. POSIX.
		У вас установлен Linux.
		Linux. Особенности разработки. Краткий очерк истории. Дистрибутивы.
		ALTLinux. Особенности дистрибутива. (Надо ли здесь приводить сведения
		о фирме, полурекламного-рекламного характера? Если не здесь, то где?)
		Linux и Unix. Краткая история. (поставить этот раздел после стандартов?)
		
	2.2 Архитектура и логика системы

		Базовые понятия и идеолгия Unix/Linux. 
			Ядро
			Процессы
			
			Все -- файл
				файловая система -- ссылка на руководство сисадм., если 
					будет там про файловые системы
				файлы устройств, драйверы устройств, "файлы процессов"
				-- ссылка на руководство по установке

			Многопользовательская система

			Права доступа
				Доступ к файлам: доступ к устройствам, управление 
				процессами. Основные утилиты управления процессами.

	2.3 Сеанс работы
			работа пользователя с системой
			команды и интерфейс -- ввести термины
			виды доступа: графический и текстовый интерфейс
			пропедевтика: первично ввести пон. ком. строка
			можно вводить комады с клавиатуры, можно мышью 
				через графический интерфейс
				Отставнов -- возникли одновременно
				клики на те же слова

		Доступ к системе через текстовый терминал

				оболочка 
				командная строка
				основные комнады оболочки
				-- справочно: другие оболочки.
				mc -- классический навигатор 
	
				стандартный ввод-вывод
				перенаправление ввода-вывода
				Базовые утилиты командной строки для работы с файлами

		Доступ к системе через графический интерфейс

				Графический сервер Х

				Оконные менеджеры

				Интегрированные рабочие среды


3. Функциональные (практические) применения компьютера
	Общее слово типа "компьютер в нашей жизни"
	Единица измерения функциональности компьютера -- пакет
	(программ). Основные понятия о целостности ситемы:
	Установка и удаление пакетов, зависимости, поддержание 
	целостности системы. 
	-- справочно: Системы управления пакетами -- со ссылками на описания

		3.1 Офисные применения
			что входит в понятие офисных программ

		3.2 Редактирование текстов
			Редактирование текстов как основное занятие в компьютере
			програмирование и т. п.

			Текстовые редакторы

			Текстовые процессоры

			IDE (Интегрированные среды разработки)
				emacs, c-forge

		3.3 Массовые вычисления и хранение систематических данных

			Калькуляторы

			Электронные таблицы

			Базы данных

		3.4 Мультимедиа
			Понятие мультимедиа

			Работа с графикой
				Растровая и векторная графика, форматы графических файлов.

				Графические редакторы 

			Работа со звуком
				Форматы звуковых файлов. Аналоговый и цифровой звук.
				Сжатие звукозаписей mp3, ogg.

				Проигрыватели

				Звукозапись

				Редактирование звуковых файлов

		3.5 Обмен информацией
			Что-нибудь про глобальное информационное пространство и 
			роль в этом компьютеров и _стандартов_.

			Сеть
				Локальная/глобальная сеть
				Локальная сеть
				Сетевые соединения и утилиты работы с сетью. 
				Возможность удаленного доступа. ssh. 
				Удаленное администрирование -- кто напишет? 

				Электронная почта
					Была первой. Хорошо бы очерк истории.
					
					Почтовые редакторы.

					MTA.

				Интернет
					Хорошо бы очерк истории. 

					Броузеры
						Mozilla
		3.6 Обеспечение работоспособности компьютера

			Системное администрирование
				Что войдет?

			Безопасность -- надо?


-----

В руководстве пользователя три главных кита --- KDE, OpenOffice, Mozilla. Остальное -- нужно 
смотреть, что войдет в дистрибутив.



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