Building awesome sample apps that actually provide value
Download as PPTX, PDF1 like205 views
The document outlines a guide for building effective sample applications that add value, focusing on empowering developers and showcasing best practices. It details a step-by-step approach including identifying project goals, creating scenarios, defining MVP requirements, implementing projects, and engaging the developer community. Additionally, it emphasizes the importance of measuring success and avoiding common pitfalls in the development process.
Building awesome sample apps that actually provide value
- 1. Building awesome sample apps that actually provide value @Lauren_Schaefer Developer Advocate, SugarCRM
- 5. How do I apply this simple example to my bigger use case? @Lauren_Schaefer 5
- 6. How do i test this? @Lauren_Schaefer 6
- 7. How do I integrate this example into my app? @Lauren_Schaefer 7
- 8. How do I quickly build a complete application? @Lauren_Schaefer 8
- 9. How do I apply DevOps best practices? @Lauren_Schaefer 9
- 10. How do I know if I’m breaking something really important? @Lauren_Schaefer 10
- 12. Today’s Goal Empower you to convince your boss that building an awesome sample app should be at the top of your priority list @Lauren_Schaefer 12
- 14. How are we going to do that? ● Case study: my sample app ● Steps to success ● Pitfalls @Lauren_Schaefer 14
- 18. Quick info about our product @Lauren_Schaefer 18 ● Sugar (Customer relationship management software) ● Highly customizable ● Customizations = upgrade challenges
- 20. Step 1: Identify project goals @Lauren_Schaefer 20 1. Be an authoritative example of how to customize the product the best way. 2. Be an example of how to follow DevOps best practices while customizing our product. 3. Be an example that our engineers can use to test they aren’t breaking common customizations.
- 21. Step 2: Create the scenario @Lauren_Schaefer 21
- 22. Step 3: Identify the requirements for the MVP @Lauren_Schaefer 22
- 23. Step 3: Identify the requirements for the MVP @Lauren_Schaefer 23
- 24. Step 3: Identify the requirements for the MVP ● Basic customizations for the scenario ○ Custom modules, fields, and layouts ● Basic test automation using PHPUnit and Jasmine ● DevOps pipeline using Travis CI ● Tests integrated into the product’s build process ● Documentation in GitHub @Lauren_Schaefer 24
- 25. Step 4: Implement the MVP @Lauren_Schaefer 25
- 26. Step 4: Implement the MVP @Lauren_Schaefer 26
- 27. Step 4: Implement the MVP @Lauren_Schaefer 27
- 28. Step 4: Implement the MVP @Lauren_Schaefer 28
- 29. Step 4: Implement the MVP @Lauren_Schaefer 29
- 30. Step 5: Continue building incrementally @Lauren_Schaefer 30
- 31. Step 5: Continue building incrementally @Lauren_Schaefer 31
- 32. Step 5: Continue building incrementally @Lauren_Schaefer 32
- 33. Step 6: Engage your engineers and developer community for help @Lauren_Schaefer 33
- 34. Step 6: Engage your engineers and developer community for help @Lauren_Schaefer 34
- 35. Step 6: Engage your engineers and developer community for help @Lauren_Schaefer 35
- 36. Step 6: Engage your engineers and developer community for help @Lauren_Schaefer 36
- 37. Step 7: Measure success ● 4 features implemented ● Automated tests with PHPUnit, Jasmine, & Postman ● CI with Travis and Jenkins @Lauren_Schaefer 37
- 38. Step 7: Measure success 1 bug found in the product @Lauren_Schaefer 38
- 39. Step 7: Measure success @Lauren_Schaefer 39
- 41. Step 1: Identify project goals @Lauren_Schaefer 41 1. Be an authoritative example of how to… 2. Be an example of how to follow DevOps best practices while… 3. Be an example that our engineers can use to test they aren’t breaking common…
- 42. Step 2: Create the scenario @Lauren_Schaefer 42
- 43. Step 3: Identify the requirements for the MVP ● Features ● Tests ● Infrastructure (CI) ● Documentation @Lauren_Schaefer 43
- 44. Step 4: Implement the MVP @Lauren_Schaefer 44
- 45. Step 5: Continue building incrementally @Lauren_Schaefer 45 ● Identify roles including product owner ● Build a full feature including test automation ● Build infrastructure as necessary
- 46. Step 6: Engage your engineers and developer community for help @Lauren_Schaefer 46 ● Get manager buy-in ● Encourage external participation at all levels
- 47. Step 7: Measure success ● Identify what metrics matter to your stakeholders ● Build metrics infrastructure if necessary ● Gather informal feedback as well @Lauren_Schaefer 47
- 49. Not having coding standards @Lauren_Schaefer 49
- 51. Failing to engage your developer community @Lauren_Schaefer 51 ● Slow PR response times ● Unclear requirements ● Uninteresting problems ● No incentives
- 53. Why build a sample app instead of separate sample code snippets? @Lauren_Schaefer 53 ● Solves bigger problems ● Shows how to build a complete solution ● Demonstrates best practices related to development and tooling ● Provides a testing resource for your product
- 54. How do you successfully build an awesome sample app that actually provides value? @Lauren_Schaefer 54 1. Identify project goals 2. Create the scenario 3. Identify the requirements for the MVP 4. Implement the MVP 5. Continue building incrementally in a transparent way 6. Engage your engineers and developer community for help 7. Measure success
- 56. Follow up... About Me @Lauren_Schaefer linkedin.com/in/laurenjane ce About the App github.com/sugarcrm/school community.sugarcrm.com/com munity/developer/pages/dev -blog @Lauren_Schaefer 56
Editor's Notes
- #11: Engineers
- #20: Java Pet Store
- #31: For new features… Build the full stack of the feature plus tests and documentation Build publicly so people can see progress of the project and learn from the code reviews
- #32: Added support for Jenkins
- #33: Added support for Postman tests Led to us discovering a bug when using our product on different databases
- #42: Be an authoritative example of how to customize the product the best way. Be an authoritative example of how to utilize your APIs. Be an authoritative example of how to utilize your software tools.
- #43: What is a common use case for your developer community? Can the scenario you selected incorporate most of the features you want to include in your sample?
- #44: Infrastructure - do you need to setup Continuous Integration to build your app? Do you need to add your app to your engineering team’s CI? Identify tools your developer community should be using. You may want to cover duplicate tools.
- #45: Get code reviews from your engineering team. Be transparent in your development.
- #46: Added support for Jenkins
- #48: This one is hard. First, you have to look at your goals. Do you measure pull requests, forks, stars on your repo? Do you run surveys? If you don’t measure your success, will you be able to continue work on your sample app?
- #51: Developers don’t care. They don’t care about the success of your sample app. They want to develop new features, not spend time working on your sample app. Unless they are given space to work on it by their managers and their performance reviews are tied to it, they probably aren’t going to help you. You’ll need developers to help review pull requests as well as develop new features.
- #52: -