search

salesforce / utam-java-recipes

Examples of testing with UTAM Java
MIT License
18 stars 17 forks source link

Request for Enhanced Documentation and Clarity in Salesforce Utam-Java-Recipes #42

Closed girish-kadambari closed 11 months ago

girish-kadambari commented 1 year ago

Here are some key areas where we believe enhancements are crucial:

  1. PageObject Class Usage: It is currently challenging to use the PageObject classes for existing Salesforce Generic flows. Clear and comprehensive documentation on how to effectively utilize these classes for various Salesforce functionalities would be immensely helpful.

  2. Test Case Creation: Creating test cases using the framework can be complex, especially for newcomers. Providing detailed guidance on which PageObject classes to use for specific types of test cases would simplify the process and reduce errors.

  3. Advantages of the Framework: It would be beneficial to have a section that outlines the advantages and benefits of using the Salesforce Utam-Java-Recipes framework. This will help users understand why they should choose this framework over others.

  4. Long-term Support Commitment: To build trust within the community, it would be reassuring to know the level of support Salesforce intends to provide for this open-source project. Knowing that Salesforce is committed to maintaining and improving the framework will encourage more users and contributors to get involved.

  5. Clarity and Accessibility: The documentation should be presented in a clear, understandable, and user-friendly manner. It should cater to both experienced developers and those who are new to the framework.

Enhancing the documentation in these areas will not only make it easier for the community to use the Salesforce Utam-Java-Recipes but also foster trust and confidence in this open-source project. We believe that a well-documented and supported framework will encourage more active participation from the community, leading to its continued growth and success.

We kindly request that you consider these suggestions and prioritize the improvement of the documentation for the Salesforce Utam-Java-Recipes framework. Your support in this matter would mean a lot to the community and contribute to the framework's long-term success.

kartikperumal commented 1 year ago

@girish-kadambari Thank you for the feedback! If could share your email address, we could add you to our slack support channel and discuss the issues you mentioned further.