Documentation/Development

From The Document Foundation Wiki
Jump to: navigation, search

What we do

The LibreOffice Documentation Team is responsible for the development of the English language documentation. In particular, we maintain the official LibreOffice User Guides.

Other documentation we work on includes:

Systems to display documentation, such as the help websites, fall more within the duties of the Website/Infrastructure Team, though there is some overlap.

How to join the team

  1. Sign up for the mailing list.
  2. Email the mailing-list at documentation.libreoffice.org to introduce yourself briefly (we don't need a CV!).
    • If you'd like to help with the published documentation, request a user account for our ODFAuthors site.
    • If you prefer to read and write messages in your browser, use Nabble once you have signed up.
  3. You can also participate in our weekly team meeting on Mondays at 18:00 Berlin time (CET)

To get some idea of topics that users ask questions about, also consider joining:

We look forward to hearing from you. :)

How to contribute

The section lists some ways you can contribute to LibreOffice documentation.

Easy tasks

These are tasks that you can perform quickly and easily, which do not necessarily require much knowledge of LibreOffice and technical writing.

User guides

From easy to involved:

  • Review a draft of a chapter or book
  • Update a chapter or book for the current version of Libreoffice, or add missing information
  • Write a new user guide chapter for the current version of Libreoffice
  • Adopt a user guide book or chapter and coordinate with other people to keep it up to date, reviewed, edited, indexed and published on time
    • Adopt one or a few chapters of a single guide
    • Adopt related chapters in several guides, for example on printing, setup options, keyboard shortcuts or customization
    • Adopt a full user guide

See the User Guides page for further instructions.

Other guides and tutorials

From easy to involved:

  • Finish an abandoned draft
  • Update an existing guide for the current version of LibreOffice
  • Adapt an old OpenOffice.org guide for the current version of LibreOffice
  • Write a new guide

See Documentation/Publications and Documentation/Other Resources for examples of completed works, many of which could use updating.

See Documentation/Wish List for other ideas of things to be done.

Built-in help

We always need help updating and improving the in-program help content.

See Documentation/Help and Documentation/Help Content for instructions.

Im-jabber.svg

Note:
These pages need to be combined and revised.

TDF wiki

From easy to involved:

  • Add missing links to user documentation pages to Documentation/Other Resources
  • Find how-tos and tutorials about LibreOffice on the web and add them to Documentation/Other Resources
  • Pick an unanswered question from the list of FAQs and answer it
  • Correct inaccurate or out-of-date information.
  • Update an outdated wiki page, or revise a one that needs better organization
  • Write a new wiki page for a topic that is missing
  • Improve the overall structure and content of the wiki

In order to edit pages on the Document Foundation wiki (the site you are at now), click Create account in the upper right.)

Other potential tasks