As an edtech platform, we have built our own LMS system and our own database system to provide a good understanding of how students are onboarded, how students are taken care of, and a database system where we have a Monday-based CRM. We primarily use ReadMe to host the interactive developer portals for documenting our LMS platform's API for external integrations and delivering professional API documentation to new team members that we onboard into our engineering team. The interactive console helps developers test endpoints quickly, which reduces our overall support load during handoffs. Here is a workflow that we tailor to our custom LMS, our database, and our CRM setup, and this is how ReadMe solves a practical problem for both of our internal onboarding and external integration systems. With ReadMe, there is a noticeable difference in how we are onboarding a new developer onto our engineering team. Since we have already built our LMS system and our database system that integrates with the Monday CRM to track student registrations and onboarding statuses, historically we had to have onboarding calls with team members and explain how these systems interact. We also had to have senior engineers hold multiple walkthrough sessions, share API keys, run manual requests in Postman, and give them a full demo. With ReadMe, the workflow becomes much more efficient because it becomes a self-guided onboarding experience. The new developer is simply handed the ReadMe portal where they have documentation of the entire endpoints responsible for syncing data from our LMS and utilizing other items in the LMS. We can use all the endpoints to see the current student status, invite a new user, re-invite a user, or add subjects to the portal. Things become much easier with interactive testing. We had development API keys that the developer used in the console to directly trigger mock student onboarding. This became friendlier with immediate feedback. They could instantly see how the database processed requests for each of the mock student statuses updated in our dev or staging CRM environment, all without having to write a single line of local code first. This reduced our developer onboarding time for the specific integration from days of back and forth to self-training and self-served afternoon tasks, freeing up the senior engineer to focus on the current development that they are working on.
AWS Marketplace is a digital catalog that hosts thousands of software listings from independent software vendors. Businesses can find, test, buy, and deploy software in one place, easing the deployment process.AWS Marketplace offers a vast range of third-party software and services for cloud-based enterprises, observable in its streamlined procurement cycle. It delivers extensive options for integration, deployment, and management of applications on the AWS cloud, optimizing agility and...
As an edtech platform, we have built our own LMS system and our own database system to provide a good understanding of how students are onboarded, how students are taken care of, and a database system where we have a Monday-based CRM. We primarily use ReadMe to host the interactive developer portals for documenting our LMS platform's API for external integrations and delivering professional API documentation to new team members that we onboard into our engineering team. The interactive console helps developers test endpoints quickly, which reduces our overall support load during handoffs. Here is a workflow that we tailor to our custom LMS, our database, and our CRM setup, and this is how ReadMe solves a practical problem for both of our internal onboarding and external integration systems. With ReadMe, there is a noticeable difference in how we are onboarding a new developer onto our engineering team. Since we have already built our LMS system and our database system that integrates with the Monday CRM to track student registrations and onboarding statuses, historically we had to have onboarding calls with team members and explain how these systems interact. We also had to have senior engineers hold multiple walkthrough sessions, share API keys, run manual requests in Postman, and give them a full demo. With ReadMe, the workflow becomes much more efficient because it becomes a self-guided onboarding experience. The new developer is simply handed the ReadMe portal where they have documentation of the entire endpoints responsible for syncing data from our LMS and utilizing other items in the LMS. We can use all the endpoints to see the current student status, invite a new user, re-invite a user, or add subjects to the portal. Things become much easier with interactive testing. We had development API keys that the developer used in the console to directly trigger mock student onboarding. This became friendlier with immediate feedback. They could instantly see how the database processed requests for each of the mock student statuses updated in our dev or staging CRM environment, all without having to write a single line of local code first. This reduced our developer onboarding time for the specific integration from days of back and forth to self-training and self-served afternoon tasks, freeing up the senior engineer to focus on the current development that they are working on.