Re: Making a Software Documentation Polyglot

[David Castro <thejavaguy -at- gmail -dot- com>]

I inherited the documentation for Google's Protocol Buffers
<https://developers.google.com/protocol-buffers>, which generates code in
Java, C++, Objective C, Python, Go, C#, Javascript, and several other
languages. We provide full documentation support for Java, C++, Objective
C, and Python, and more-limited support for the other languages.

When implementing this, the original author created a codelab using include
files so that the language-specific content could be swapped in. Not as
elegant as conditional text, but it is what was supported by the hosting
platform at the time. I'll be evaluating how to handle how to support the
languages as I get further into the project. (I joined at the beginning of
Q3, so I'm still acclimating.)

In other docs, we call out language-specific concerns within the docs. Not
ideal, but it works.

On Tue, Feb 1, 2022 at 6:03 AM Oquance <serdar -dot- a -dot- ozmen -at- gmail -dot- com> wrote:

> Dear All,
>
> I was wondering whether any fellow writers have worked on a project
> mentioned in the Subject field. If so, could you please share the
> challenges you've faced?
>
> In our case, our software documentation (mix of concepts and tutorials) has
> been targeted to Java developers. But as we grow, users from other
> programming languages also have started to use our product. So, we want to
> make the content of this documentation language-independent, but having
> difficulties in starting the journey.
>
> Thanks in advance.
>
> Serdar
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Visit TechWhirl for the latest on content technology, content strategy and
> content development | https://techwhirl.com
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as thejavaguy -at- gmail -dot- com -dot- 
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
> http://www.techwhirl.com/email-discussion-groups/ for more resources and
> info.
>
> Looking for articles on Technical Communications?  Head over to our online
> magazine at http://techwhirl.com
>
> Looking for the archived Techwr-l email discussions?  Search our public
> email archives @ http://techwr-l.com/archives
>


-- 
-David Castro
 thejavaguy -at- gmail -dot- com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | https://techwhirl.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot- 

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications?  Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions?  Search our public email archives @ http://techwr-l.com/archives