How to improve Developer Documentations ?
•Download as PPTX, PDF•
0 likes•131 views
The document proposes solutions to improve the Teams Dev Docs by addressing developer pain points. It identifies key pain points such as difficulty finding relevant content and understanding errors. Possible solutions include a chatbot that can quickly answer questions and documentation that allows coding in native languages. User research is cited to validate the identified pain points. A phased go-to-market strategy is proposed starting with targeted launches of the chatbot and native language support to capture early adopters. The solutions aim to reduce time spent on documentation and increase new developer adoption.
Report
Share
How to improve Developer Documentations ?
- 1. Product Recommendations for Teams Dev-Docs by Utsav Parashar
- 3. Company Mission (for developers) “to empower every developer and every dev based organization on the planet to achieve more.” Teams Platform Vision “to provide a single hub for teamwork in Office 365 since teamwork is essential to the way work gets done today.”
- 4. Objective of Teams Dev Docs “to get the developers off the Dev docs as soon as possible so that they can start building apps.”
- 5. Competitor Analysis (Teams Dev Docs)
- 6. Launched No. of Third Party Apps No. of Developers Slack 2013 1,800 600,000 Microsoft Teams 2017 500+ Initial Stages Zoom 2011 700+ N/A
- 7. Slack API Docs (First Fold)
- 8. Teams API Docs (First Fold)
- 9. Development Stages & Pain Points
- 10. Stage of Development Awareness Discovery Learning Implementation Debugging Developer Pain Points Not sure about which platform to choose and why What are the documents that would help me resolve my questions How to get overview of the platform capabilities/ integrations How to quickly integrate sample code Find out common errors and their solutions Role of Teams Dev Docs (Dev Level: Beginner) N/A Be easily discoverable on Search engines, prompt the user to learn more Discover what are the areas that the Developer is weak in, provide tutorials Step by step guide to impelmentation, providing support whereever necessary List out the most common errors and provide support in case the Dev is unable to proceed Role of Teams Dev Docs (Dev Level: Intermediate) Introduction to the Teams platform capabilities Be easily discoverable on Search engines, prompt the user to try code N/A Provide a way to test out the APIs and its request/response data Provide support and a way to connect with experts Role of Teams Dev Docs (Dev Level: Advanced) Why the developers must choose to build on Teams platform over other platforms N/A N/A Provide sample code and other resourses as quickly as possible Incentivize them to contribute to the Developer forums
- 12. Business Objective User Problem (Gap Analysis) Product Stage Metric to be moved Create a large developer community for Teams platform Find out relevent content as quickly as possible Adoption Time spent on Dev docs must be reduced by 30% while keeping the #New Developers increasing Call out - Assumption needs to be validated using extensive user-study (& MVP experiments) Business Objective User Problem (Gap Analysis) Product Stage Metric to be moved Create a large developer community for Teams platform Find out relevent content as quickly as possible Adoption Time spent on Dev docs must be reduced by 30% while keeping the #New Developers increasing
- 14. User Problem (Gap Analysis) Find out relevent content as quickly as possible Possible Solution 1 Possible Solution 2 Possible Solution 3 Build a chatbot that understands what the user wants and quickly provides the same Provide a manual Chat interface where the users can ask their questions Revamp the UX providing minimalistic experience and intent filters Reach Very High Low High Impact Very High High Medium Confidence High Medium Medium Effort High Medium High Priority Rank 1 3 2 Use - Assumption needs to be validated using extensive user-study (& MVP experiments)
- 15. Use Case (Chatbot) 1. User spends XX amount of time on Dev docs & still not moving ahead 2. Chatbot is displayed Call out: Value of XX will be based on user-study
- 19. Tradeoffs for Solution 1. Opportunity cost is high 2. Developers (especially advanced ones) might not feel comfortable with this new way to use Dev Docs 3. Developers might give incorrect input and might not understand how to use the 4. Addition of one more feature would mean that the tech team might loose focus on their existing tasks
- 20. Appendix
- 21. Company Vision “to help people and businesses throughout the world realize their full potential.” Company Mission “to empower every person and every organization on the planet to achieve more.”
- 22. Teams-Competitive Landscape Size of the target organization #Features Zoom Google Classroom TeamViewer Go to Webinar Slack Dropbox for Business Teams
- 23. SWOT - Teams Platform Strengths - Credibility and brand of Microsoft - Good technical support Weakness - Difficult to transition from Outlook - Structure of files confuses users Opportunities - Better app ecosystem - Mass adoption i.e. B2C Threats - Competitors can replicate its features - Security i.e Hacking
- 24. User Research (for Dev Docs) ● Talked to several developers ● Questioned them about their issues with existing Dev docs ● Understood their pain points ● Used the 5 Why's method to dig deeper
- 25. User Research (observations) ● Documentation is not correct ● Error scenarios not covered ● I use 'Postman' to understand the results/errors ● Documentation is not 'sectioned' correctly ● If a doc is not clear, I do a 'Google search' ● If I get a 'sample code' it would really help ● Collaboration with other developers is critical while development ● Communication with the larger developer community i.e. experts is a delight
- 26. Target User Persona (Based on User Research) For Tech & Dev Docs...
- 28. Ankit's User Journey Map
- 29. 1. Ease of adoption - How to switch to the new technology/ecosystem - Migration to the new developer platform, learn new languages 2. Consistency and standards - Does the Dev Docs follow consistent and standard set of technologies - Will I be able to find more developers who can code along with me on the same projec 3. Backward compatability - Does the Dev Docs make it clear which are the APIs, tools that will be depricated and when - Would the old applications & components be working with the deprectated Teams features or not 4. Security - Can the apps built on top of Teams platform be hacked - What are the other velnerabilities of the system 5. Bugs & Error Support - How do I get my errors resolved - Can I aviod the common errors that arise during coding Ankit's Top Pain Points
- 30. A superior 'Tech and Dev Docs' would help Teams build healthy app ecosystem, developer community and hence ensure its market dominance. Solution Hypothesis (Based on User Research)
- 31. Pain Point Solution/ Feautures 1. Ease of adoption - How to switch to the new technology/ecosystem - Migration to the new developer platform, learn new languages - Make it easy for developers to setup the dev tools - Provide complete information of underlying tech-stack 2. Consistency and standards - Does the Dev Docs follow consistent and standard set of technologies - Will I be able to find more developers who can code along with me on the same project - Connect the Developer to dev community (let him easily find peers in his City/Region) - Dev Docs must make it easy for developers how to code in their existing language and integrate the same with teams platforms 3. Backward compatability - Does the Dev Docs make it clear which are the APIs, tools that will be depricated and when - Would the old applications & components be working with the deprectated Teams features or not - Give complete visibiltiy on timelines and life cycle of each feature - Provide support and incentives for the developers to migrate to the new features and upgrade their code 4. Security - Can the apps built on top of Teams platform be hacked - What are the other velnerabilities of the system - Give an overview of the architecture of teams platform to the developers - Clearly mention any risks or potential loop holes 5. Bugs & Error Support - How do I get my errors resolved - Can I aviod the common errors that arise during coding - Provide a chatbot that can answer common developer queries - Personalize the web pages for each developer by predicting the type of query that they can encounter
- 32. Solution/ Feautures Reach Impact Confidence Effort - Make it easy for developers to setup the dev tools High Medium Low Medium - Provide complete information of underlying tech-stack High Medium Medium Medium - Connect the Developer to dev community (let him easily find peers in his City/Region) High High High High - Dev Docs must make it easy for developers how to code in their existing language and integrate the same with teams platforms Very High Very High High Very High - Give complete visibiltiy on timelines and life cycle of each feature Medium Medium Medium High - Provide support and incentives for the developers to migrate to the new features and upgrade their code Medium Medium Medium High - Give an overview of the architecture of teams platform to the developers Low Medium Low Medium - Clearly mention any risks or potential loop holes High High Medium Low - Provide a chatbot that can answer common developer queries Very High Very High Very High High - Personalize the web pages for each developer by predicting the type of query that they can encounter High Very High High High
- 33. Solution/ Feautures Priority Rank - Provide a chatbot that can answer common developer queries 1 - Dev Docs must make it easy for developers how to code in their existing language and integrate the same with teams platforms 2 - Personalize the web pages for each developer by predicting the type of query that they can encounter 3 - Connect the Developer to dev community (let him easily find peers in his City/Region) 4 - Clearly mention any risks or potential loop holes 5 - Provide complete information of underlying tech-stack 6 - Make it easy for developers to setup the dev tools 7 - Give complete visibiltiy on timelines and life cycle of each feature 8 - Provide support and incentives for the developers to migrate to the new features and upgrade their code 9 - Give an overview of the architecture of teams platform to the developers 10
- 34. Wireframes/ Information Architecture Feature 2 (Native language Dev Docs)
- 36. Success Metrics
- 37. Provide a chatbot that can answer common developer queries
- 38. Dev Docs must make it easy for developers how to code in their existing language and integrate the same with teams platforms
- 39. Go to Market Strategy Feature 1 (Chatbot)
- 40. Offer Provide a chatbot that can answer common developer queries Pricing Free to use Market Segmentation Software developers - Teams Platform Positioning Most advanced and easy to use tech documentation, Cool new tech Messaging “Checkout the coolest new chatbot that makes it fun to code” Strategy Capture a 'threshhold market' via paid promotions and then make it easy for existing users to refer the feature to other developers Launch Plan Launch in a single city with vibrant tech community (e.g Bangalore) and then scale to other cities/ regions Budget $ XXX
- 41. Go to Market Strategy Feature 2
- 42. Offer Dev-Docs must make it easy for developers how to code in their existing language and integrate the same with teams platforms Pricing Free to use Market Segmentation Software developers - Teams Platform Positioning Take advantage of Teams Platform and build cool apps/components Messaging “Work on cutting edge of technology, build cool apps and components on top of MS Teams platform” Strategy Promote the feature on popular tech forums e.g. Stack overflow, Geeksforgeeks.com etc Launch Plan Invite a few top 1% coders to try out the feature, get their positive recommendations and then roll it out to the wider audience Budget $ XXX
- 43. Phase 2,3 (Future) Ideas 1. Can consider a text to voice feature that can read out the documentation 2. Online tutorials and webinars related to integration of Teams platfrom APIs etc 3. Addition of a lot of plug and play modules, libraries etc 4. Online forum where delevelopers can post their query and video chat with other developers regarding same 5. A global community i.e. social network of Microsoft developers where they can hang out, share their cool new projects and create online/offline events etc. 6. Online hackathons of Teams platform developers and 'open sourcing' the code 7. A completely personalized, AI based virtual assistant that helps that developers easily discover, learn, implement and debug/troubleshoot their applications
- 44. ======== End of Presentation=======