Documentation/Development/User Guides

From The Document Foundation Wiki
Jump to: navigation, search

We use NextCloud as a production site, with published documentation placed on this wiki Publications page and on the LibreOffice website.

Workflow

Details of our workflow have changed, as our working files are now located on NextCloud, not ODFAuthors.

Workflow

Below is the workflow we are theoretically using. (To be expanded.)

For detailed instructions, see the contributor's guide linked below.

If you have need help at any point in the process, remember Documentation Team mailing list and #documentfoundation connect via webchat.

Author/updater:

  1. Create draft document according to:
  2. Upload draft to the appropriate folder
  3. Submit your document for review.

Reviewer:
Author: Revise as needed
Copyeditor:
Publisher:

At each stage, fill in the appropriate task spreadsheet on NextCloud and report what you have done to the document team mailing list (documentation@global.libreoffice.org).

Task status

Tasks are tracked using a spreadsheet in the NextCloud folder for each user guide.

Using OmegaT for translation

OmegaT is a Computer Aided Translation tool that can be used to handle the translation of the guides produced by the Documentation team. Miloš Šrámek has made a presentation about his workflow. The wiki page UsingOmegaT describes the process based on the development he shared.

Downloads

Contributors Guide

Note: some chapters are out of date and are being revised.

Chapter 2016-17 version
1 Joining the LibreOffice Documentation Team ODT / PDF (7 Oct 2016)
2 Producing LibreOffice User Guides ODT / PDF (7 Oct 2016)
3 Using the ODFAuthors website ODT / PDF (8 Oct 2016)
4 Style Guide for LibreOffice User Guides ODT / PDF (Being revised)
5 Using the LibreOffice Chapter Template ODT (Being revised)

Chapter templates

Source files for cover art (SVG)