documentation requirements

[lzb-libra]

Describe the feature

I hope the SDK has a foolproof documentation that allows me, like a novice, to follow your documentation step by step, rather than omitting most of the code that is not important to your task and adding some comments.

Use Case

Perhaps my cultivation is not enough, and it is difficult to read and develop documents.
https://docs.aws.amazon.com/zh_cn/sdk-for-java/latest/developer-guide/home.html

Proposed Solution

Provide foolproof documentation, please do not treat developers as gods

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

AWS Java SDK version used

2.21.5

JDK version used

1.8

Operating System and version

win11

[debora-ito]

@lzb-libra thank you for your feedback, we appreciate it.

We aim to provide clear explanation with helpful code examples in our Developer Guide, but if it's not helping developers to start using the SDK we are clearly failing on that premise. I understand how the initial setup to use the SDK can be overwhelming.

Is there any specific topic that I can help you with? Let me know your specific questions about how to use the Java SDK and I can explain it here.

[debora-ito]

@lzb-libra

Asking again if you have any specific question we can answer here, or any specific deep-dive tutorials you'd like see.
Requests of specific examples are easier for us to take action.

If no comments are made, this issue will auto close soon.

[github-actions]

It looks like this issue has not been active for more than five days. In the absence of more information, we will be closing this issue soon. If you find that this is still a problem, please add a comment to prevent automatic closure, or if the issue is already closed please feel free to reopen it.

[lzb-libra]

@lzb-libra thank you for your feedback, we appreciate it.

We aim to provide clear explanation with helpful code examples in our Developer Guide, but if it's not helping developers to start using the SDK we are clearly failing on that premise. I understand how the initial setup to use the SDK can be overwhelming.

Is there any specific topic that I can help you with? Let me know your specific questions about how to use the Java SDK and I can explain it here.

I've been going through the documentation available, and for someone familiar or experienced with AWS, it might not pose much of a challenge. However, as a developer new to AWS, I find myself grasping most of the explanations provided, but when it comes to practical implementation, I'm at a loss. There are certain jar files that I'm not familiar with and unsure of their purposes. Specifically, in integrating the functionalities of IoT Core, I'm uncertain about which jar files to include and where to begin. I need a comprehensive walkthrough—from identifying the necessary jar files to each step required to successfully integrate your services—starting from scratch.