Ich würde sagen, es ist eher ein unüblicher Case, dass man über diesen Weg irgendeine form von wichtiger Information an den Shopbetreiber gibt. Es kann ja in deinem Case notwendig sein, aber i.d.R. erfolgt dies in Form einer Dokumentation (bspw. online oder intranet).
Unabhängig davon kannst du doch “description” in der plugin.xml nutzen und wenn du dich an die xml-Richtlinien hälst natürlich auch HTML nutzen. Mein Beispiel funktioniert einwandfrei:
hallo
]]>
Das hat ja nix mit Shopware zu tun, dass man HTML in XML entsprechend Kennzeichnen muss.