RFC Template For Engineering Initiatives
Revision History
| |
Author | |
Contributors |
|
Date | Jun 19, 2024 |
Comment | Initial draft |
Status | In progress |
Approvers | VP of Engineering: Tosin Agagu |
Approvals | Tosin Agagu In Review |
Informed | Research & Development - Pending
Please share via email with R&D team - research@moniepoint.com |
|
Summary
A brief paragraph or bullet points that clearly explain your goals.
Background
What motivates this proposal and why is it important?
Our goal is to clearly articulate the value of our actions.
Problem
There is no API documentation for a number of services in the Channels department.
Proposal
This is the heart of your proposal, meant to help you think through the problem. Writing it down helps clarify your thoughts.
Consider:
Using diagrams to illustrate your ideas.
Including code examples if you're proposing an interface or system contract.
Linking to relevant project briefs or wireframes.
Metrics & Dashboards
Identify the key metrics to measure. For example, if interacting with an external system, measure external system latency. If adding a new table, consider how quickly it would fill up.
Drawbacks
Discuss any potential reasons against implementing this proposal. This section aims to evaluate risks and provide a balanced view.
Alternatives
Explore other methods to achieve the same outcome, providing a comparison of different approaches
Potential Impact and Dependencies
Consider the broader context and the potential impact on other systems or teams. Assess how this proposal might be exploited by malicious attackers.
Open Questions
Highlight any aspects of the proposal that are still undefined or not covered, indicating areas that require further exploration.
Conclusion
Summarize why this is the right decision at this time and outline the next steps for moving forward
Writing an RFC offers your team insight into your direction. While there may not always be a clear right or better decision, the process is a learning opportunity. By authoring an RFC, you are making a decision on the proposed direction and seeking feedback, but ultimately, the decision is yours.
This document serves as:
A thinking exercise and prototype with words.
A historical record, though its value may decrease over time.
A way to broadcast information.
A mechanism to build trust.
A tool to empower.
A communication channel.
References
https://medium.learningbyshipping.com/writing-is-thinking-an-annotated-twitter-thread-2a75fe07fade
https://teamapt.atlassian.net/wiki/spaces/MAE/pages/1321107568