c81e4fcb9e
we've decided to rename design docs to blueprints to indicate that we don't intend to keep blueprints up to date once completed. instead, the final step of blueprint implementation is to archive the blueprint and update actual documentation elsewhere (potentially copying and pasting most of the blueprint). this PR updates the template and readme
789 B
789 B
[Title]
Abstract
[A short summary of what this blueprint 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.]
Wrapup
[Who will archive the blueprint when completed? What documentation needs to be updated to preserve the relevant information from the blueprint?]
Open issues
[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.]