Общее положение о стиле

Общее положение о стиле изложения, а также правила перевода и семантики использования труднопереводимых фраз, названий и действий. Правила форматирования текста в формате SGML

Общие правила

1. Документация FRDP пишется в формате SGML. Исключения составляют файлы docbook, различные служебные файлы, не относящиеся непосредственно к документации, иллюстрации и скриншоты.
2. Каждый файл должен содержать revision strings (`FreeBSDru' и `FreeBSD'), причём последняя должна быть пустой. Отдельной строкой указывается Original revision: x.yyy, где x.yyy -- номер версии исходного (английского) документа, которому в настоящий момент соответствует перевод. Пример можно посмотреть в Учебнике по проекту документирования FreeBSD для новых участников.
3. В теге, указывающем тип документа следует также указать язык. Это нужно для отображения на русском некоторых элементов.

   <book lang="ru">
   <article lang="ru">

4. Длину строк в файлах (только в самой документации FRDP) желательно ограничивать 70 символами.
5. При обновлении (!) документации, для последующего более лучшего восприятия и просмотра изменений другими участниками Проекта не стоит сильно стараться ограничивать длину строки в вышеупомянутые 70 символов путём переноса оставшейся части на новую строку. Если же стоит выровнять текст в указанные 70 символов, то лучше сделать это отдельным коммитом и в лог сообщении указать, что данный коммит содержит только выравнивание текста.
6. Все переводы должны проверяться программой проверки орфографических ошибок. Можно воспользоваться программой ispell: /usr/ports/russian/rus-ispell.
7. При написании SGML отступы должны составлять 2 пробела. 8 пробелов подряд заменяются на символ табуляции. Исключением из последнего правила является содержимое тегов screen, programlisting, userinput: они не должны содержать табуляций.
8. Все местоимения, относящиеся к пользователю (вы, вам, вас, вашей и пр.) пишутся с прописной буквы.
9. Слова, содержащие букву `ё' (йо), должны писаться как есть (то есть через `ё', а не `е', как часто принято).
10. Предложения отделяются друг от друга двумя пробелами.

Соглашения по переводу часто употребляемых технических терминов (в алфавитном порядке); первым указывается наиболее предпочтительный перевод

• account, n.
  • учётная запись
  • аккаунт (не бюджет)
• adapter, n.
  • адаптер
• backslash character
  • символ обратной косой черты
• backspace character
  • символ забоя
• cache, n.
  • кэш
• column
  • столбец (таблицы), колонка (текста, шириной в несколько слов), столбец (экрана, шириной в один символ)
• command script
  • командный сценарий
• command shell
  • командная оболочка
• committer, n.
  • коммиттер
• contributor, n.
  • контрибутор
• custom kernel, n.
  • собственное, специализированное ядро
• desktop, n.
  • настольный компьютер
  • десктоп
• directory, n.
  • каталог (не директория)
• domain, n.
  • домен
• download, n.
  • загрузка
• drive, n.
  • привод (например, привод CDROM)
• environment variable
  • переменная окружения
• firewall, n.
  • [защитный] сетевой экран
  • брандмауэр
  • файервол
• framework, n.
  • подсистема
  • инфраструктура
• hacker, n.
  • хакер
• hard drive, n.
  • жёсткий диск
• hard link
  • жесткая связь (между именем и inode)
• hash, n.
  • хэш
• host, n.
  • хост
• human-readable
  • удобочитаемый
• inode
  • индексный дескриптор
• installation, n.
  • установка
  • инсталляция
• ISP (provider), n.
  • поставщик услуг Internet, провайдер
  • ISP (общеупотребительно)
• loopback interface (device), n.
  • интерфейс (устройство) обратной связи (желательно в скобках оставлять английское название)
• manual page, n.
  • страница справочника
• mount a file system
  • смонтировать файловую систему
• mounted file system
  • смонтированная файловая система
• package, n.
  • пакет (не пакадж/пэкэдж/etc)
• partition, n.
  • раздел (не партиция)
• patch, n.
  • патч (не заплатка)
• playback, n.
  • воспроизведение (не проигрывание)
• primary
  • примитив
• raw PCM, n.
  • простые аудио данные PCM
  • необработанные аудио данные PCM
• release engineering team, n.
  • группа подготовки релизов
• resolve a symbolic link
  • разыменовать символическую ссылку
• resolver, n.
  • резолвер
• to resolve, v.
  • разрешать
  • резолвить (?)
• screenshot, n.
  • скриншот
• script
  • сценарий
• security team, n.
  • команда по безопасности
• shell
  • оболочка
• shell script
  • сценарий оболочки
• slash
  • косая черта
  • прямая косая черта
• slice, n.
  • слайс
• snapshot, n.
  • снэпшот
• standard error
  • стандартный файл ошибок
• standard input
  • стандартный ввод
  • стандартный файл ввода
• standard output
  • стандартный вывод
  • стандартный файл вывода
• stream
  • поток
• symbolic link
  • символическая ссылка (ссылка одного имени на другое)
• thread
  • нить
• unmount a file system
  • размонтировать файловую систему
• whitespace characters
  • пробельные символы (когда имеются ввиду и пробелы, и табуляции)

Не допускается использование сугубо технического ("хакерского") жаргона, например "винт", "сетевуха", "фря", "винда", "юзер" и пр.