Re: Suggestion for writing release notes

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 5 September 2012 22:24:31 Couret Charles-Antoine wrote:
> Hi all,
> My name is Fedora and I am a French ambassador. Since Fedora 16, I
> write the announce in French for the new Fedora release.
> The French team, who translate Fedora, found the release notes written
> enough, too short and not suitable for public. It's difficult to
> translate and understand these documents.
> It is more a concatenation of all provided strings without so much flourish.
> 
> I think, the releases notes require to many skills in "data processing"
> to understand the news in Fedora. For me, it's the official document to
> communicate the changelog with the public and actually, it's not
> possible with that.
> 
> With the French team, we thought to write the release notes in French
> and translate that in English for others translation team.
> If you are ok to this project, I can write the document before the 17th
> September, it's sufficient for others translation in future.
> 
> That could be a Publican replacement for the usual Release Notes. I
> don't master yet Publican but I am willing to learn.
> 
> In short, the idea is to provide the Release Notes for Fedora 18 in a
> detail document avoiding the usual phrasing like bellow:
> " Desktop - GNOME has been updated to the latest release XX;
> - KDE has been updated to the latest release YY;
> - Mate has been packaged for the first time in Fedora.."
> 
> The original document would be written in French but translated in
> English throught Transifex. Of course, we would need English people to
> proofread and improve our translation.
> 
> 
> You can read my precedent work for that (Fedora 16 and 17) :
> https://fedoraproject.org/wiki/User:Renault/Promotion/Fedora_17
> https://fedoraproject.org/wiki/User:Renault/Promotion/Fedora_16
> 
> It is more detailed, explained and written.Briefly, for a wide
> dissemination.
> 
> Thank you for giving me your opinion on the subject.
> Charles-Antoine Couret — Renault

Hi Couret:

This is only my opinion, but I think we should collaborate, rather than change languages.

First, thank you for contacting us before writing the Release Notes in French.
I can't speak for other contributors, but I am surprised that short documentation
is more difficult to translate. It makes sense now that I think of it,
because when we write the documentation, we already know what we're thinking,
but when you translate documentation, you don't know what we were thinking.

You could help us learn to write in an easy-to-translate way by giving
some examples of difficult phrases, then showing what we could write instead.
Many of the Release Notes contributors, like myself, are not professional
technical writers. We would certainly appreciate any advice you have.

Second, as I said at the beginning, I think we should collaborate. If we collaborate,
we can expand our community in new ways. The way we currently write documentation
in Fedora (first in English, then translated) is a waste of resources. There
are many talented and engaged contributors, like you, who could help write
our documentation in a non-English language, then translate it to English. There
are also many contributors like myself who are willing and able to translate
from non-English languages, but who are not comfortable writing in them.

What's even more important is that we have an opportunity to encourage cross-
cultural cooperation. Even if the effect is limited to the people who work on
the Release Notes, we should all be thankful we have this chance to work together
to build something for ourselves and our users.

There are many possible technical problems. Does Transifex allow a document to
have multiple source languages? Would we be able to coordinate who will write
about which components? I think we can ignore these for now (see below).

What I Propose:
=======I welcome you, and everybody, to contribute to the Release Notes in your
preferred language. At least for now, please use the existing categories
for the English-language Release Notes:

https://fedoraproject.org/wiki/Docs/Beats

The ideal result is that many of the Beats will be translated into English from
another language (probably mostly French this time), and many of the Beats will
still be translated from English into other languages. We will have multiple
languages on every wiki page, but that's okay. If it's too confusing, we can
choose a better system for future Fedora releases.

For this first time--especially because the Release Notes must be finished
soon--we should still take the English version as the "primary" version for
Transifex. But when we move the English Release Notes to Transifex, you can
copy your original from the wiki. Transifex doesn't need to know that we wrote
some sections in French then translated to English!

The worst result, I think, is that the Release Notes would be written multiple
times, but once for each language, and the wiki pages will be confusing and too
long.


What does everybody think?



Christopher.
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.12 (GNU/Linux)

iQIcBAEBAgAGBQJQR8d7AAoJEGpo1cWDqVnYWScP+QHPQvw9F4IkzCJqaDuj2oup
w5Ttx1ulmEdBcJT5LKQ1Dog+PABCAvpwZbEmp0ii4NI7CtD9FyBPg4+5TuBJV3TY
ukOhkSD9Z6hENmdcJRGUui6eUfRPnn8eB0AkSfbxDNaBxAVxnPJzaaLLFJqqQxdH
yDy4Xjp5lDmpyNdBX2PP35rieiLSxsDFdktx3ZOg1LzGDU+aRIqwDAHqwJKVeFxY
/HKcHQuY0GVTVm6588xjpdTtOWVNnvqB8owomug2XZOpwvtaRRD0p63CPM/qrUos
JsXEL/CK13+nHSRGX+9p0jsVH9rR33HeLEzvP+DmPMEYRoiiZmo3wbI/YM1D3+Dp
e4pXxEwwxVJG1Yx9umHd5nY2iw5MxYjJQ0owKWV/RGPMuMCnMIpoXG/Hj3uV2u1Q
KudrKFz5u3N6RKoi10ifWNdmuzfdYo40iPi29vHpNLBnrUSJsRNZj7yyebXP7swM
/Hzn2MttJVWYSjnqEMlF37j5u+zJ3909goIdIbSXU4aaCeydl3Kwx83/gOW/YKqx
vfNPp0dGBPVcC/8TJWrw/R9vtvDcckJsQsYo0vJbCeTlp+wDwO9L3v0rNkJ2vUjS
GCddJaMYz/i6FB7rdPVzorCkwFuDFMUCcowW1+VmiU+MGzSY6PZuCBQExHhSp+RJ
bbKGnMpWaXS6KjuC7oEe
=SLlb
-----END PGP SIGNATURE-----

-- 
docs mailing list
docs@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe:
https://admin.fedoraproject.org/mailman/listinfo/docs



[Index of Archives]     [Fedora Users]     [Fedora Desktop]     [Red Hat 9]     [Yosemite News]     [KDE Users]

  Powered by Linux