Разработка документации

From The Document Foundation Wiki
Jump to: navigation, search

Разработка документации

Официальные руководства для пользователей доступны на странице «Публикации».

В качестве рабочего используется сайт ODFAuthors, опубликованная документация размещается на странице «Публикации». Затем создаются ссылки на эти руководства с официального сайта LibreOffice.

Если Вы хотите присоединиться к проекту и стать участником команды, пожалуйста:

  1. Подпишитесь на список рассылки. Отправьте пустое письмо по электронной почте на documentation+subscribe@global.libreoffice.org. Вы должны получить ответ с инструкциями по последующим действиям.
  2. Напишите в список рассылки Documentation Team mailing list письмо с краткой информацией о себе (CV или биография не требуются!).
  3. В письме запросите, пожалуйста, учетную запись для нашего сайта ODFAuthors.

После этого мы начнём к Вам прислушиваться. :)


Первые шаги в проекте документации

Руководства для участников

Для тех, кто присоединился к проекту документации. Некоторые части остаются в виде черновиков, некоторые являются слегка устаревшими и будут переработаны.



Отдельные части:       версии 2012-13
  1   Присоединение к проекту документации LibreOffice   ODT или  PDF   8 ноября 2012
  2 Создание Руководств Пользователя по LibreOffice ODT или PDF 24 августа 2013
  3 Использование сайта ODFAuthors ODT или PDF 8 ноября 2012
  4 Wiki, блоги, социальные сети Готовится
  5 Руководство по стилям для Руководст Пользорвателя по LibreOffice ODT или PDF 8 ноября 2012
  6 Использование шаблнов для частей документации по LibreOffice ODT 8 ноября 2012
  7 Использование диалога AutoText ODT 8 ноября 2012
 

Шаблоны для руководств пользователя



        3.3     3.4     3.5-4.3     4.4     5.0  

Исходные файлы для дизайна обложки



                  3.4     3.5  
    3.5 French version    
    передняя часть обложки для 4.0 (SVG)    передняя часть обложки для 4.2-4.3 (SVG)   
    задняя часть обложки для 4.0 (SVG)    задняя часть обложки для 4.2-4.3 (SVG)   

Что можно делать

Руководства пользователя

Рабочий процесс

Workflow on ODFAuthors

Ниже описан теоретически используемый рабочий процесс. Фактически, некоторые шаги процесса рецензирования не выполняются из-за отсутствия людей, которые могут это делать.

Работа с сайтом ODFAuthors

  1. Создать черновик документа в соответствии с:
  2. Загрузить черновик в соответствующий каталог для черновиков:
    1. Зарегистрироваться на сайте ODFAuthors.
    2. Выбрать каталог LibreOffice > English > (подходящий каталог для документа) > Drafts. (Прим. переводчика: На сайте отсутствует раздел Russian, в качестве подходящего каталога выбирается Writer, Calc, Base etc.).
    3. Щелкнуть "Add new" и затем выбрать File из появившегося меню.
    4. Ввести название и описание документа.
    5. Щелкнуть по кнопке Browse, чтобы указать сайту, что файл находится на жестком диске.
    6. Щелкнуть по кнопке Save для выгрузки файла.
  3. Отправить документ на проверку:
    • Щелкнуть "State: Internal draft" и выбрать "Submit for publication". (Состояние изменится на "State: Pending review".)
  4. Сообщить о готовности в список рассылки проекта документации (documentation@global.libreoffice.org).

Загрузка файла для проверки

  1. Зарегистрироваться на сайте ODFAuthors.
  2. LibreOffice > English > (подходящий каталог для документа) > Drafts.
  3. Щелкнуть на файле, который требуется загрузить. Браузер откроет диалог загрузки файла.
  4. Изменить статус файла:
    • Щелкнуть "State: Pending review" и выбрать Retract. (Состояние изменится на "State: Internal draft".)

Выгрузка файла после проверки

  1. Зарегистрироваться на сайте ODFAuthors.
  2. LibreOffice > English > (подходящий каталог для документа) > Feedback.
  3. Щелкнуть "Add new" и затем выбрать File из появившегося меню.
  4. Ввести название и описание документа.
  5. Щелкнуть по кнопке Browse, чтобы указать сайту, что файл находится на жестком диске.
  6. Щелкнуть по кнопке Save для выгрузки файла.

Отправка документа на прооверку

  1. Перейти в каталог Draft, содержащий файл для проверки.
  2. Изменить состояние проверяемого документа.
  3. Щелкнуть "State: Internal draft" и выбрать "Submit for publication". (Состояние изменится на "State: Pending review".)
  4. Сообщить о готовности в список рассылки проекта документации (documentation@global.libreoffice.org). В основном, автор будет проверять изменения, принимая или отклюняя их по отдельности.
  5. Тот, кто проверяет черновик, при необходимости вносит изменения в режиме записи изменений, результаты помещает в раздел Reviewed.
  6. Автор (или кто-то другой, в зависимости от книги и обстоятельств) проверяет исправления в черновиках, отключает режим записи изменений переводит файл в раздел Drafts -- ИЛИ переходит к шагу 5.
  7. Шаги 2 и 3 повторяются по мере надобности.
  8. По готовности автор (или кто-то другой) перемещает файл из раздела Reviewed в раздел Copyediting/Proofing.
  9. Редактор работает в режиме записи изменений, результаты помещает в Feedback.
  10. Автор (или кто-то другой) принимает или отклюняет режакторские правки, перемещает файл в каталог Indexing/Final Layout, отмечая как готовый для дальнейшей обработки.
  11. Индексатор/Координатор книги/кто-то еще окончательно все проверяет и перемещает файл в каталог Published (или возвращает в Feedback на доработку).
  12. Координатор книги/Издатель/кто-то еще формирует выходной файл в различных форматах (PDF, по остальным надо решить) и делает его общедоступным, сохраняя копию в рабочем каталоге для следующих редакций.

При наличии вопросов следует помнить о Documentation Team mailing list и #documentfoundation connect via webchat.

Для получения более подробной информации по проверке и обновлению руководств пользователя LibreOffice (включая создание иллюстраций, перекрёстные ссылки, оглавления и публикацию), см Руководство «Producing LibreOffice User Guides».

Состояние задач для пользовательской документации

Этот раздел перемещён на отдельную страницу, User Guide Tasks, на которой отслеживается прогресс разработки каждой книги. Там указано, кто работает над каждой частью, этапы разработки и даты.

На этой странице (англ.) перечислены изветсные темы, которые нужно добавить в различные книги для завершения их к дате выхрола версии 5.1. На эту страницу можно добавлять примечания (заметки).

Использование OmegaT при переводе

OmegaT -- автоматизированная система компьютерного перевода, которая может быть использована для поддержки перевода руководств, разработанных в рамках проекта документации. Miloš Šrámek создал презентацию об использовании системы, на этой странице (англ.) описан соответствующий процесс совместной разработки.

Прочие документы

Ниже приведены некоторые документы, требующие разработки.

Руководство администратора

Может быть основано на OpenOffice.org Admin Guide.

Руководство по программированию на Basic

Может быть основано на OpenOffice.org BASIC Programmers' Guide.

Руководство программиста

Может быть основано на OpenOffice.org Developers' Guide.

Примеры для Math

Здесь первая версия черновика (англ.) - комментарии приветствуются.

Списки пожеланий по документации

Список пожеланий для пользовательской документации

Здесь можно указать позиции, которые желательно реализовать в качестве пользовательской документации. Очевидно, что всё сделать невозможно, за исключением ситуации с наличием достаточного количества людей для выполнения работы, однако иметь список пожеланий полезно -- кто-то может посмотреть на какую-то позицию и выразить желание это реализовать.

  • Руководства пользователя в других форматах
    • формат wiki
    • формат ePub --> см. EPUB (англ.)
  • ЧаВо (англ.) (на этом сайте) - работа начата; кто может помочь?
  • Рецепты (HowTos)
  • Реорганизация структуры wiki-страниц документации - работа начата; кто может помочь?
  • Учебники, в форматах PDF и ODT
  • Видеоуроки
  • Обучающие материалы (возможно, следует привлечь другие группы в сообществе LibreOffice?)
  • Документы для отдельных групп пользователей, например, технических писателей, представителей малого бизнеса, студентов университетов
  • Брошюры по отдельным темам для пользователей со средним и большим опытом
  • Библиотека материалов, которые могут быть использованы более чем в одном документе. Например, некоторые сведения по установке, настройке, печати и экспорту в PDF используются в руководствах по различным компонентам (для использования участниками проекта документации, не для открытого доступа).
  • Коллекция примеров для LibreOffice Math (например, разметка для матрицы 4x4 с заполнителями для нескольких строк)
  • Обновление и адаптация the OpenOffice.org 2.0 migration guide для LibreOffice

Список пожеланий по документации для разработчиков

Здесь можно указать позиции, которые желательно реализовать в качестве документации для разработчиков.

  • Сборка пакетов (.deb, .rpm, .dmg, .pisi,...)
  • Объектная модель UNO/LibreOffice (объекты, методы, свойства) одинаково полезна для разработчиков макросов и разработчиков LibreOffice.

  Несколько диаграмм иерархии объектной модели могут помочь новичкам быстрее освоиться.  

  • Рабочий процесс разрабочиков, включая git, запуск soffice с отладчиком и когда собирать всё или модули.  ЧаВо по различным этапам разработки.  (Возможно, это относится к разделу «Разработка»).