create doc folder & upload design_doc.md template

cmu-db · Jan 29, 2024 · 6d68aab · 6d68aab
1 parent 71534e2
commit 6d68aab
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/doc/README.md b/doc/README.md
@@ -0,0 +1,3 @@
+# Catalog Service Design Docs
+
+This folder contains Catalog design docs.
diff --git a/doc/design_doc.md b/doc/design_doc.md
@@ -0,0 +1,23 @@
+# Catalog
+
+* Zilong Zhou ([email protected])
+* Yen-Ju Wu ([email protected])
+* Chien-Yu Liu ([email protected])
+
+## Overview
+>What is the goal of this project? What will this component achieve?
+
+## Architectural Design
+>Explain the input and output of the component, describe interactions and breakdown the smaller components if any. Include diagrams if appropriate.
+
+## Design Rationale
+>Explain the goals of this design and how the design achieves these goals. Present alternatives considered and document why they are not chosen.
+
+## Testing Plan
+>How should the component be tested?
+
+## Trade-offs and Potential Problems
+>Write down any conscious trade-off you made that can be problematic in the future, or any problems discovered during the design process that remain unaddressed (technical debts).
+
+## Glossary (Optional)
+>If you are introducing new concepts or giving unintuitive names to components, write them down here.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Catalog Service Design Docs

		This folder contains Catalog design docs.