mirror of
https://github.com/IRS-Public/direct-file.git
synced 2025-06-28 04:25:52 +00:00
74 lines
2.3 KiB
Markdown
74 lines
2.3 KiB
Markdown
|
# RFC: [Title Here]
|
|||
|
|
- Created: [mm/dd/yyyy]
|
|||
|
|
- Approver(s):
|
|||
|
|
- PR: if applicable
|
|||
|
|
- Gitlab Issue: if applicable
|
|||
|
|
# Primary author(s)
|
|||
|
|
[primary authors]: #primary-authors
|
|||
|
|
|
|||
|
|
who owns this document and should be contacted about it?
|
|||
|
|
|
|||
|
|
# Collaborators
|
|||
|
|
[collaborators]: #collaborators
|
|||
|
|
anyone who contributed but isn’t a primary author.
|
|||
|
|
|
|||
|
|
# Problem Statement
|
|||
|
|
[problem statement]: #problem-statement
|
|||
|
|
Why are we doing this? What use cases does it support? What is the expected outcome?
|
|||
|
|
|
|||
|
|
# Prior Art
|
|||
|
|
|
|||
|
|
What existing solutions are close but not quite right? How will this project replace or integrate with the alternatives?
|
|||
|
|
|
|||
|
|
# Goals and Non-Goals
|
|||
|
|
[goals and non-goals]: #goals-and-non-goals
|
|||
|
|
What problems are you trying to solve? What problems are you not trying to solve?
|
|||
|
|
|
|||
|
|
# Key terms or internal names
|
|||
|
|
|
|||
|
|
Define terms and language which might be referenced in the background and Suggested Solution below
|
|||
|
|
|
|||
|
|
# Background & Motivation
|
|||
|
|
[background and motivation]: #background--motivation
|
|||
|
|
What is the current state of the world? Why is this change being proposed?
|
|||
|
|
|
|||
|
|
# Suggested Solution
|
|||
|
|
[design]: #suggested-solution
|
|||
|
|
What exactly are you doing? Include architecture and process diagrams.
|
|||
|
|
|
|||
|
|
This is typically the longest part of the RFC.
|
|||
|
|
|
|||
|
|
# Timeline
|
|||
|
|
[timeline]: #timeline
|
|||
|
|
What is the proposed timeline for the implementation?
|
|||
|
|
|
|||
|
|
# Dependencies
|
|||
|
|
[dependencies]: #dependencies
|
|||
|
|
What existing internal and external systems does this one depend on? How will it use them?
|
|||
|
|
|
|||
|
|
# Alternatives Considered
|
|||
|
|
[alternatives]: #alternatives-considered
|
|||
|
|
What other approaches did you consider?
|
|||
|
|
|
|||
|
|
# Operations and Devops
|
|||
|
|
[operations]: #operations-and-devops
|
|||
|
|
What operational work is needed to implement this idea? What kind of IRS SME's should be involved? What is the "lift" from an operational perspective?
|
|||
|
|
|
|||
|
|
What additional telemetry and monitoring would be required to implement this?
|
|||
|
|
# Security/Privacy/Compliance
|
|||
|
|
[security privacy compliance]: #security-privacy-compliance
|
|||
|
|
What security/privacy/compliance aspects should be considered?
|
|||
|
|
|
|||
|
|
# Risks
|
|||
|
|
[risks]: #risks
|
|||
|
|
What known risks exist? What factors may complicate your project?
|
|||
|
|
|
|||
|
|
Include: security, complexity, compatibility, latency, service immaturity, lack of team expertise, etc.
|
|||
|
|
|
|||
|
|
# Revisions
|
|||
|
|
[revisions]: #revisions
|
|||
|
|
RFC Updates for major changes, including status changes.
|
|||
|
|
- created
|
|||
|
|
- updated
|
|||
|
|
- revisions based on feedback
|
|||
|
|
- final status
|