design-template: reduce heading depth
Reduce heading depth from the start to reduce depth of sub-headings in
detailed design. As the designs are meant to stand alone, they do not
need an explicit initial depth of 3.
Change-Id: Ib037c2da81962d7b5bee8dc01916e1269e189e5e
Signed-off-by: Patrick Venture <venture@google.com>
diff --git a/designs/design-template.md b/designs/design-template.md
index 76cc0f1..c730132 100644
--- a/designs/design-template.md
+++ b/designs/design-template.md
@@ -1,5 +1,5 @@
____
-### Design Guidelines - *Delete this section*
+# Design Guidelines - *Delete this section*
* Not all new features need a design document. If a feature can be
contributed in a single reasonably small patchset that has little impact
@@ -23,7 +23,7 @@
will also allow inline feedback on the diagram itself.
____
-### Example design - this is the design title
+# Example design - this is the design title
Author:
< Name and IRC nic >
@@ -34,14 +34,14 @@
Created:
< Date initially created, revisions in will be tracked in Gerrit >
-#### Problem Description
+## Problem Description
(1 paragraph) What are we doing and why? What problem are you trying to
solve? What are the goals and NON-goals? Please make the objective
understandable for someone unfamiliar with this project by including the
necessary context, but keep it short. Elaborate on the details below in the
Background and Requirements sections.
-#### Background and References
+## Background and References
(1-2 paragraphs) What background context is necessary? You should mention
related work inside and outside of OpenBMC. What other Open Source projects
are trying to solve similar problems? Try to use links or references to
@@ -51,7 +51,7 @@
write about your design, specific requirements details, or ideas to solve
problems here.
-#### Requirements
+## Requirements
(2-5 paragraphs) What are the constraints for the problem you are trying to
solve? Who are the users of this solution? What is required to be produced?
What is the scope of this effort? Your job here is to quickly educate others
@@ -59,7 +59,7 @@
your implementation. Roughly estimate relevant details. How big is the data?
What are the transaction rates? Bandwidth?
-#### Proposed Design
+## Proposed Design
(2-5 paragraphs) A short and sweet overview of your implementation ideas. If
you have alternative solutions to a problem, list them concisely in a bullet
list. This should not contain every detail of your implementation, and do
@@ -67,15 +67,15 @@
elements in a very succinct manner. Which technologies will you use? What
new components will you write? What technologies will you use to write them?
-#### Alternatives Considered
+## Alternatives Considered
(2 paragraphs) Include alternate design ideas here which you are leaning away
from. Elaborate on why a design was considered and why the idea was rejected.
Show that you did an extensive survey about the state of the art. Compares
your proposal's features & limitations to existing or similar solutions.
-#### Impacts
+## Impacts
API impact? Security impact? Documentation impact? Performance impact?
Developer impact? Upgradability impact?
-#### Testing
+## Testing
How will this be tested? How will this feature impact CI testing?