Someone told me I should consider translating my repo README into multiple languages. Is it really helpful? How do you maintain single-source-of-truth?
Ask HN: Multilingual READMEs Are Helpful?
1–6 of 6 posts
Re: Ask HN: Multilingual READMEs Are Helpful?
#2If your project is multilingual, sure. Otherwise anyone can translate it on their own anyway.
Look into translation management systems for maintaining a source of truth. There's a lot of them out there.
Re: Ask HN: Multilingual READMEs Are Helpful?
#3If your project is multilingual, sure. Otherwise anyone can translate it on their own anyway. Look into translation management systems for maintaining a source of truth. There's a lot of them out there.
The project is open-source and has a lot of users from all over. The code itself is in python so English of course. I was wondering if this is considered nice/inviting to have more than one language in README, or not really necessary..?
Re: Ask HN: Multilingual READMEs Are Helpful?
#4If your project is multilingual, sure. Otherwise anyone can translate it on their own anyway. Look into translation management systems for maintaining a source of truth. There's a lot of them out there.
The project is open-source and has a lot of users from all over. The code itself is in python so English of course. I was wondering if this is considered nice/inviting to have more than one language in README, or not really necessary..?
If someone offers to contribute a README translation and to keep it updated with every change, you can consider merging it. It indicates that there are existing users who want to talk about the project in their native language. And that somebody could e.g. open an issue in that language to ask questions and get help.
But if there is no such community, a translated README on its own is pointless in my opinion.
Re: Ask HN: Multilingual READMEs Are Helpful?
#5If your project is multilingual, sure. Otherwise anyone can translate it on their own anyway. Look into translation management systems for maintaining a source of truth. There's a lot of them out there.
The project is open-source and has a lot of users from all over. The code itself is in python so English of course. I was wondering if this is considered nice/inviting to have more than one language in README, or not really necessary..?
I think yorwba said it best... if an organic community develops naturally around one language or another, cool, encourage it and make it easier for them however you can!
But no need to "fake it" with preemptive translations of your own (especially if you're going to do it automatically) if it's going to take time and effort away from other parts of the project. It's more important to have good and thorough documentation in ONE language rather than a barebones readme in ten.
Re: Ask HN: Multilingual READMEs Are Helpful?
#6If you speak another language and can write it more intelligibly than google translate can, then yes. But just google translating your readme is not helpful. Anyone can do that themselves.
> Is it really helpful?
Have you ever seen a library/program that was written by a Chinese developer, but which had an English readme in addition to the Chinese one? Well, imagine if it only had Chinese.
I disagree with the other comment saying there needs to be an established community in the other language first. There are projects I would never have used or even discovered if they had been written solely in the dev's native tongue. But again, this is assuming you actually speak another language and can write it properly; a shitty AI translation will do more harm than good.
> How do you maintain single-source-of-truth?
The English readme is the source of truth. When you change that, change the TL too. If that's too much work, then just don't bother. An out of date translation is often worse than no translation.