logo selfpublishingguru.com

 topic : Re: What to do when API objects and UI names are different? This question is in reference to API documentation. Say the name of an object is "Action" in the backend, but "Step" in the UI. We

Ravi5107385 @Ravi5107385

This happens all the time. Sometimes it's not even the programmers' fault. :-)

I agree that you must use the API names. After all, you are documenting what needs to be used in programming. Yes, you can mention the UI label -- which might even change at some point.

UI labels are meant to work for users, and they are constrained by space, localization concerns, style rules, and other considerations. API objects, commands and parameters need only be unique and (somewhat) readable.

10% popularity Vote Up Vote Down

0 Reactions   React


Replies (0) Report

0 Comments

Sorted by latest first Latest Oldest Best

SelfPubGuruLearn self publishing
Back to top | Use Dark Theme