Start interfacedocumenten in meerdere talen met velddefinities: namen, typen, eenheden, bereiken en betekenissen van nulwaarden en ontbrekende waarden. Maak onderscheid tussen protocol-ID's en de uitleg van de lezer. Tenzij de interfacedefinitie dit toestaat, mag u de veld-ID's, opsommingswaarden of foutcodes niet wijzigen bij het vertalen van natuurlijke taal.
Bewaar versies en toewijzingen voor wijzigingen
Wanneer parameterbetekenis, standaardwaarden, foutafhandeling of structuurwijzigingen plaatsvinden, noteert u de interfaceversie en migratieregels. Koppel gelokaliseerde documenten aan dezelfde versie en markeer secties die nog niet zijn bijgewerkt. Bewaar eerdere definities, herzieningen en voorbeelden om te voorkomen dat oude en nieuwe instructies door elkaar worden gehaald.
Controleer voorbeelden met de daadwerkelijke interface
Parseer verzoeken en antwoorden in de afgesproken omgeving. Controleer velden, waarden en foutvertakkingen. Gebruik stabiele ID's om gelokaliseerde foutverklaringen te koppelen. Controleer ontbrekende parameters, ongeldige waarden en niet-ondersteunde versies. Rapporteer vertaalde voorbeelden pas als geverifieerd nadat u de bijbehorende controles hebt uitgevoerd.
Controleer samen de taal en de tekstrichting
W3C-internationaliseringsrichtlijnen bespreken informatie over taal en tekstrichting voor berichten in natuurlijke taal. Onderscheid leesbare uitleg van programma-ID's. Controleer bidirectionele tekst, codefragmenten en nummerpresentatie. Behoud weergave- en parseringsresultaten. Een leesbare lay-out vervangt de verificatie van de protocolfunctie niet.