diff --git a/--FOR-TRANSLATORS----.md b/--FOR-TRANSLATORS----.md new file mode 100644 index 0000000..402b761 --- /dev/null +++ b/--FOR-TRANSLATORS----.md @@ -0,0 +1,21 @@ +Please follow these suggested guidlines when translating Tilde doc's: + +This will sound like gobbledygook if you don't know git, but I'm putting it +here as a placeholder. + +I would suggest linking translations to the specific github commit that +they are translating (Just by adding a line with a link to the specific +commit on Github.) +This means that updating translations can be as simple as: + +1) Diffing the "current" FAQ from the version linked by the translation to +see what changed. +2) Translating/updating just the parts that changed. +3) Updating the "based on revision [LINK]" at the top of the translated FAQ + +Thus even if things go out of sync it will be very clear what went out of +sync. And it becomes very apparent to a volunteer what needs to be done +next. + +This process can be documented more intelligently than I have done here +inside the FAQ itself, in time, if it is adopted. \ No newline at end of file