openJIIDocs
Design Decisions

Proposal template

The project's historical template for documenting a technical proposal.

This template is preserved from the previous documentation without changing its substance.

[Proposal Title]

Overview

Purpose

Describe the problem or opportunity being addressed and explain why it is important.

Scope

Define the boundaries of the proposal by specifying what is included and what is excluded.

Background

Provide context on the current situation and challenges that led to this proposal.

Proposal

Detail the proposed solution, outlining the key elements and how it addresses the identified issues.

Implementation

Steps

List the actions required to implement the proposal, such as updating documentation, modifying infrastructure, testing, deployment, and post-deployment monitoring.

Timeline

Provide an estimated timeline for the implementation process.

Dependencies

Identify any dependencies or required coordination with other teams or systems.

Proposal Feedback

Invite stakeholders to provide their input on the proposal, and explain how feedback will be used to refine the approach.

On this page