In my opinion, a bilingual documentation should be just fine. For ease of use (and to prevent surprises), i'd specify right at the beginning that "the document is available in the following languages" and maybe state in a sentence or two where to find which language.

It seems you technically don't even need to use proper english or characters that are used in any other language, thanks to the ability of UTF8 to combine stuff. I'm looking at you, Acme::Umlautify

But in your case, making sure that english is one of the languages in the documentation would be very appreciated. Yes, the final use case might be limited to a certain region or language. But always think of the person that is hired to do the actual implementation of a project that uses your library (or, for that matter, maintain the software in years to come). They might be from a completely different part of the world.

PerlMonks XP is useless? Not anymore: XPD - Do more with your PerlMonks XP

In reply to Re: Perl module documentation language conventions by cavac
in thread Perl module documentation language conventions by Polyglot

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.