storj/docs/design/TEMPLATE.md
2019-05-08 15:43:23 -04:00

703 B

[This is a template for Storj v3 design docs]

Title: [Title]

Abstract

[A short summary of what this design doc accomplishes at a high level.]

Background

[An introduction of the necessary background and the problem being solved.]

Design

[A precise statement of the design and its constituent subparts.]

Rationale

[A discussion of alternate approaches and the trade offs, advantages, and disadvantages of the specified approach.]

Implementation

[A description of the steps in the implementation.]

Open issues (if applicable)

[A discussion of issues relating to this proposal for which the author does not know the solution. This section may be omitted if there are none.]