|
| 1 | +# AUTO-GENERATED, DO NOT EDIT! |
| 2 | +# Please edit the original at https://github.com/ory/meta/blob/master/templates/repository/common/.github/ISSUE_TEMPLATE/DESIGN-DOC.yml |
| 3 | + |
| 4 | +description: |
| 5 | + "A design document is needed for non-trivial changes to the code base." |
| 6 | +labels: |
| 7 | + - rfc |
| 8 | +name: "Design Document" |
| 9 | +body: |
| 10 | + - attributes: |
| 11 | + value: | |
| 12 | + Thank you for writing this design document. |
| 13 | +
|
| 14 | + One of the key elements of Ory's software engineering culture is the use of defining software designs through design docs. These are relatively informal documents that the primary author or authors of a software system or application create before they embark on the coding project. The design doc documents the high level implementation strategy and key design decisions with emphasis on the trade-offs that were considered during those decisions. |
| 15 | +
|
| 16 | + Ory is leaning heavily on [Google's design docs process](https://www.industrialempathy.com/posts/design-docs-at-google/) |
| 17 | + and [Golang Proposals](https://github.com/golang/proposal). |
| 18 | +
|
| 19 | + Writing a design doc before contributing your change ensures that your ideas are checked with |
| 20 | + the community and maintainers. It will save you a lot of time developing things that might need to be changed |
| 21 | + after code reviews, and your pull requests will be merged faster. |
| 22 | + type: markdown |
| 23 | + - attributes: |
| 24 | + label: "Preflight checklist" |
| 25 | + options: |
| 26 | + - label: |
| 27 | + "I could not find a solution in the existing issues, docs, nor |
| 28 | + discussions." |
| 29 | + required: true |
| 30 | + - label: |
| 31 | + "I agree to follow this project's [Code of |
| 32 | + Conduct](https://github.com/ory/go-acc/blob/master/CODE_OF_CONDUCT.md)." |
| 33 | + required: true |
| 34 | + - label: |
| 35 | + "I have read and am following this repository's [Contribution |
| 36 | + Guidelines](https://github.com/ory/go-acc/blob/master/CONTRIBUTING.md)." |
| 37 | + required: true |
| 38 | + - label: |
| 39 | + "I have joined the [Ory Community Slack](https://slack.ory.sh)." |
| 40 | + - label: |
| 41 | + "I am signed up to the [Ory Security Patch |
| 42 | + Newsletter](https://www.ory.sh/l/sign-up-newsletter)." |
| 43 | + id: checklist |
| 44 | + type: checkboxes |
| 45 | + - attributes: |
| 46 | + description: |
| 47 | + "Enter the slug or API URL of the affected Ory Network project. Leave |
| 48 | + empty when you are self-hosting." |
| 49 | + label: "Ory Network Project" |
| 50 | + placeholder: "https://<your-project-slug>.projects.oryapis.com" |
| 51 | + id: ory-network-project |
| 52 | + type: input |
| 53 | + - attributes: |
| 54 | + description: | |
| 55 | + This section gives the reader a very rough overview of the landscape in which the new system is being built and what is actually being built. This isn’t a requirements doc. Keep it succinct! The goal is that readers are brought up to speed but some previous knowledge can be assumed and detailed info can be linked to. This section should be entirely focused on objective background facts. |
| 56 | + label: "Context and scope" |
| 57 | + id: scope |
| 58 | + type: textarea |
| 59 | + validations: |
| 60 | + required: true |
| 61 | + |
| 62 | + - attributes: |
| 63 | + description: | |
| 64 | + A short list of bullet points of what the goals of the system are, and, sometimes more importantly, what non-goals are. Note, that non-goals aren’t negated goals like “The system shouldn’t crash”, but rather things that could reasonably be goals, but are explicitly chosen not to be goals. A good example would be “ACID compliance”; when designing a database, you’d certainly want to know whether that is a goal or non-goal. And if it is a non-goal you might still select a solution that provides it, if it doesn’t introduce trade-offs that prevent achieving the goals. |
| 65 | + label: "Goals and non-goals" |
| 66 | + id: goals |
| 67 | + type: textarea |
| 68 | + validations: |
| 69 | + required: true |
| 70 | + |
| 71 | + - attributes: |
| 72 | + description: | |
| 73 | + This section should start with an overview and then go into details. |
| 74 | + The design doc is the place to write down the trade-offs you made in designing your software. Focus on those trade-offs to produce a useful document with long-term value. That is, given the context (facts), goals and non-goals (requirements), the design doc is the place to suggest solutions and show why a particular solution best satisfies those goals. |
| 75 | +
|
| 76 | + The point of writing a document over a more formal medium is to provide the flexibility to express the problem at hand in an appropriate manner. Because of this, there is no explicit guidance on how to actually describe the design. |
| 77 | + label: "The design" |
| 78 | + id: design |
| 79 | + type: textarea |
| 80 | + validations: |
| 81 | + required: true |
| 82 | + |
| 83 | + - attributes: |
| 84 | + description: | |
| 85 | + If the system under design exposes an API, then sketching out that API is usually a good idea. In most cases, however, one should withstand the temptation to copy-paste formal interface or data definitions into the doc as these are often verbose, contain unnecessary detail and quickly get out of date. Instead, focus on the parts that are relevant to the design and its trade-offs. |
| 86 | + label: "APIs" |
| 87 | + id: apis |
| 88 | + type: textarea |
| 89 | + |
| 90 | + - attributes: |
| 91 | + description: | |
| 92 | + Systems that store data should likely discuss how and in what rough form this happens. Similar to the advice on APIs, and for the same reasons, copy-pasting complete schema definitions should be avoided. Instead, focus on the parts that are relevant to the design and its trade-offs. |
| 93 | + label: "Data storage" |
| 94 | + id: persistence |
| 95 | + type: textarea |
| 96 | + |
| 97 | + - attributes: |
| 98 | + description: | |
| 99 | + Design docs should rarely contain code, or pseudo-code except in situations where novel algorithms are described. As appropriate, link to prototypes that show the feasibility of the design. |
| 100 | + label: "Code and pseudo-code" |
| 101 | + id: pseudocode |
| 102 | + type: textarea |
| 103 | + |
| 104 | + - attributes: |
| 105 | + description: | |
| 106 | + One of the primary factors that would influence the shape of a software design and hence the design doc, is the degree of constraint of the solution space. |
| 107 | +
|
| 108 | + On one end of the extreme is the “greenfield software project”, where all we know are the goals, and the solution can be whatever makes the most sense. Such a document may be wide-ranging, but it also needs to quickly define a set of rules that allow zooming in on a manageable set of solutions. |
| 109 | +
|
| 110 | + On the other end are systems where the possible solutions are very well defined, but it isn't at all obvious how they could even be combined to achieve the goals. This may be a legacy system that is difficult to change and wasn't designed to do what you want it to do or a library design that needs to operate within the constraints of the host programming language. |
| 111 | +
|
| 112 | + In this situation, you may be able to enumerate all the things you can do relatively easily, but you need to creatively put those things together to achieve the goals. There may be multiple solutions, and none of them are great, and hence such a document should focus on selecting the best way given all identified trade-offs. |
| 113 | + label: "Degree of constraint" |
| 114 | + id: constrait |
| 115 | + type: textarea |
| 116 | + |
| 117 | + - attributes: |
| 118 | + description: | |
| 119 | + This section lists alternative designs that would have reasonably achieved similar outcomes. The focus should be on the trade-offs that each respective design makes and how those trade-offs led to the decision to select the design that is the primary topic of the document. |
| 120 | +
|
| 121 | + While it is fine to be succinct about a solution that ended up not being selected, this section is one of the most important ones as it shows very explicitly why the selected solution is the best given the project goals and how other solutions, that the reader may be wondering about, introduce trade-offs that are less desirable given the goals. |
| 122 | +
|
| 123 | + label: Alternatives considered |
| 124 | + id: alternatives |
| 125 | + type: textarea |
0 commit comments