Ideas for improving DevGuide

Mike Kaganski mikekaganski at hotmail.com
Tue Mar 8 12:32:58 UTC 2022


On 08.03.2022 15:05, Hossein Nourikhah wrote:
> 2. It discusses multiple languages
>      a. Most of the examples are in Java which is not very useful today
>      b. Multiple languages, from Java to C++ and C# are used in the book
>          * It is hard to follow
>          * It does not work as a reference with the tutorial style of 
> the book
>          * What is the target audience?

Please do not reduce the language set. If needed, you might think of 
something similar to what MS uses in their documentation: a set of 
examples doing the same, written in different languages, and sharing the 
same code block on the page - you just select which language sample you 
need, using a selector.

See e.g. 
https://docs.microsoft.com/en-us/dotnet/api/system.web.ui.clientscriptmanager, 
where there's a selector at the top, allowing you to chose from 
C#/VB/F#/C++, and the examples on the page adjust accordingly.

Generally, trying to simplify documentation by removing "rarely used" 
stuff is IMO bad. Use selectors, expandable sections, but do not remove 
what is not obsolete.

-- 
Best regards,
Mike Kaganski


More information about the LibreOffice mailing list