Table of Contents
Table of Contents
- Keep all RFCs under a single location
- Uniquely identify RFCs
- Use a shared template
- Editor: Name <email>
- Status: Draft/Review/Approved/Abandoned/Implemented
- Required approvers: Name <email> (why), Name <email> (why), …
- Approvers: Name <email> (date), Name <email> (date), …
- Created on: <date>
- Updated on: <date>
- Overview: A high level description of what you’re describing in the document
- Background/Context: Context relevant to understanding the document
- Problem description: Describe what you are currently cannot do and want to be able to do
- Motivation/Why: Why is it relevant to solve this problem now?
- Drawbacks/Why not: What are the downsides of solving this problem?
- Proposed solution: What is the best solution proposed?
- Alternative solutions: What are the alternative solutions considered and why aren’t they the proposed solution?
- Impact and risks: What will be the impact of this change on existing systems, processes, or stakeholders?
- Unresolved questions: What are the questions that need to be answered but don’t have an answer to yet?
- References: Documents/URLs that can be useful to consult
- If a RFC is abandoned, the reasons why should be made explicit in the document
References
#
Repositories with RFCs
#