Добро пожаловать в Проект Документирования FreeBSD. Наличие документации хорошего качестве очень важно для успеха FreeBSD, и Проект Документирования FreeBSD (FreeBSD Documentation Project - FDP) организован для создания этой документации. Ваше участие очень важно.
Главное назначение этого документа заключается в четком описании того, как организован FDP, как создавать и присылать документацию для FDP и как эффективно использовать доступные вам инструменты при написании документации.
К участию в FDP приглашаются все. Нет никаких минимальных требований, предъявляемых к участникам, нет квот по объему документации, которую вам нужно написать за месяц. Все, что вам нужно - это подписка на список рассылки Список рассылки Проекта Документации FreeBSD.
После того, как вы прочтете этот документ, вы должны:
Знать, какая документация поддерживается в FDP.
Уметь читать и понимать исходный код SGML в объеме документации, которая ведется в FDP.
Уметь вносить изменения в документацию.
Уметь передавать ваши изменения обратно для просмотра и последующего включения в документацию FreeBSD.
В FDP ведется документация FreeBSD четырех категорий.
Системные англоязычные справочные страницы созданы не в FDP, так как они являются частью системы. Однако FDP может (и делает) перефразировать части существующих справочных страниц для того, чтобы сделать их более понятными или с целью устранения неточностей.
Команды переводчиков отвечают за перевод системных справочных страниц на другие языки. Эти переводы поддерживаются в FDP.
FAQ предназначен для разрешения вопросов (в форме кратких ответов на них), которые задаются или могут задаваться в различных списках рассылки и новостных конференциях, посвященных FreeBSD. Формат не разрешает длинных и подробных ответов.
Руководство предназначено быть полным онлайновым ресурсом и справочником для пользователей FreeBSD.
Это главное представительство FreeBSD в сети Интернет, доступное по адресу http://www.FreeBSD.org/ и на многих зеркалах по всему миру. Посещение веб-сервер является первым знакомством с FreeBSD для многих людей.
Эти четыре категории документации все доступны в дереве CVS FreeBSD. Это означает, что протоколы изменений в этих файлах общедоступны, и кто угодно может воспользоваться программой типа CVSup или CTM для хранения собственной копии этой документации.
Кроме того, на других веб-сайтах, посвященных FreeBSD, имеется много учебников, написанных другими людьми. Некоторые из них также располагаются в хранилище CVS (если автор согласился с этим). В других случаях автор решил хранить свою документацию отдельно от главного хранилища FreeBSD. FDP старается давать ссылки на максимальное количество такой документации.
Этот, и другие документы, могут быть скачаны с ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/.
По вопросам, связанным с FreeBSD, прочитайте документацию прежде чем писать в <questions@FreeBSD.org>.
По вопросам, связанным с этой документацией, пишите <doc@FreeBSD.org>.
По вопросам, связанным с русским переводом документации, пишите в рассылку <frdp@FreeBSD.org.ua>.
Информация по подписке на эту рассылку находится на сайте проекта перевода.