Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Additional solution documentation intended to facilitate developer onboarding #282

Open
vazmigue opened this issue Oct 23, 2024 · 0 comments
Assignees

Comments

@vazmigue
Copy link

While each function in the code is properly documented, it's hard is to get a full grasp about which actions the solution is taking at every step and why they are being taken. Even for technical roles, you might not get a full view of the solution in a short amount of time. This limits customers that are willing to build on top of this solution. Some issues that we have identified while on-boarding technical roles into PCA:

  • Lack of knowledge about call centers and its terminology. We are talking about the metadata that you might find in audio files, CLMs, audio channels, hertzs, narrobands, etc
  • Lack of knowledge about Amazon Transcribe. Understand their different APIs (Standard, Call-Analytics) and what’s the criteria for invoking one or the other. Same applies for understanding what information is transcribed by each API mode (and when you need Comprehend for things like Sentiment Analysis)

This task will add an additional PCA_walkthrough.md file in which each component of the architecture is explained and documented.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant