From Modelio Community

Jump to: navigation, search

One of the easiest ways to contribute to Modelio is to help translate its documentation into different languages.


How to contribute

The Modelio documentation is split between the different projects present in the Modelio Forge. There will soon be a project for Modelio Modeler, as well as a dedicated project per module. Documentation projects are usually sub-projects of a main project and each supported language is usually a sub-project of the documentation project. For example, the Modelio project (the project supporting the modeler itself) has a documentation sub-project named Modelio User Manual. This documentation project is itself made up of two sub-projects, one for the English user manual and one for the French user manual. This separation makes it easier to manage the different teams in charge of a particular language.

Participants use each project's Wiki in the forge to collectively create and edit the documentation.

In most cases, the most up-to-date documentation is usually the English version. However, it the responsability of the documentation project leader to define such policies and rules.

Contributing to an existing documentation project in an existing language

There are two possibilities here: either you are already a member of the project or not. For a project member, things are straightforward. The project member is usually granted the right to directly edit in documentation project's wiki. Again, this is left to the project leader to decide. For a non-member, contributing is somewhat indirect. You'll have to post your contribution (new or modified text) in the project forum (or some other place defined by the project leader) so that your contribution is first peer-reviewed before being included in the wiki. Once again, all this depends on the project-specific policies and rules as defined by the project leader.

Creating a new documentation project or a new language sub-project

For both project members and non-members, the creation of a new documentation project or language sub-project remains the prerogative of the project leader. Just contact him and perhaps it will be your turn to become the new documentation language sub-project leader.

About your translation task

The following advice from "Linux for Schools: Localization and Translation" is a good starting point:

Your task is ... to convey the content, so do not be afraid to localize the original text with something completely different (something that fits, of course). Read the original text, understand its content, and consider how you would formulate the text in your language (without first having heard of the original text).

The following guidlines are also worth considering:

  • Try to be consistent with the use of words. Translating a word using different synonyms throughout Modelio would probably make it difficult for people to understand what you are talking about.
  • Try to use the same writing style as the original text. If this style is very formal, use a formal style, if the original style is more colloquial, stick with it.
  • Keep in mind that most of the documentation will be read by users in a browser. Uses links and make sure pages are of a reasonable length.
Personal tools