refactor design section

microsoft · Aug 15, 2024 · c237f25 · c237f25
1 parent eda6a89
commit c237f25
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 5 deletions.
diff --git a/...s/feature-story-design-review-template.md → ...s/template-feature-story-design-review.md b/...s/feature-story-design-review-template.md → ...s/template-feature-story-design-review.md
@@ -1,4 +1,6 @@
-# Your Feature or Story Design Title Here (prefix with DRAFT/WIP to indicate level of completeness)
+# Template: Feature / Story Design Review
+
+**Your Feature or Story Design Title Here (prefix with DRAFT/WIP to indicate level of completeness)**
 
 > Does the feature re-use or extend existing patterns / interfaces that have already been established for the project?
 > Does the feature expose new patterns or interfaces that will establish a new standard for new future development?

diff --git a/.../milestone-epic-design-review-template.md → .../template-milestone-epic-design-review.md b/.../milestone-epic-design-review-template.md → .../template-milestone-epic-design-review.md
@@ -1,4 +1,6 @@
-# Your Milestone/Epic Design Title Here (prefix with DRAFT/WIP to indicate level of completeness)
+# Template: Milestone / Epic Design Review
+
+**Your Milestone/Epic Design Title Here (prefix with DRAFT/WIP to indicate level of completeness)**
 
 > Please refer to <https://microsoft.github.io/code-with-engineering-playbook/design/design-reviews/recipes/milestone-epic-design-review-recipe/> for things to keep in mind when using this template.
 

diff --git a/...ws/recipes/task-design-review-template.md → ...ws/recipes/template-task-design-review.md b/...ws/recipes/task-design-review-template.md → ...ws/recipes/template-task-design-review.md
@@ -1,6 +1,8 @@
-# Your Task Design Title Here (prefix with DRAFT/WIP to indicate level of completeness)
+# Template: Task Design Review
 
-> When developing a design document for a new task, it should contain a detailed design proposal demonstrating how it will solve the goals outlined below.  
+**Your Task Design Title Here (prefix with DRAFT/WIP to indicate level of completeness)**
+
+> When developing a design document for a new task, it should contain a detailed design proposal demonstrating how it will solve the goals outlined below.
 > Not all tasks require a design review, but when they do it is likely that there many unknowns, or the solution may be more complex.
 > The design should include diagrams, pseudocode, interface contracts as needed to provide a detailed understanding of the proposal.
 

diff --git a/...-reviews/recipes/sprint-spike-template.md → ...views/recipes/template-technical-spike.md b/...-reviews/recipes/sprint-spike-template.md → ...views/recipes/template-technical-spike.md
@@ -1,4 +1,6 @@
-# Spike: {Name}
+# Template: Technical Spike
+
+**Spike: {Name}**
 
 - **Conducted by:** {Names and at least one email address for follow-up questions}
 - **Backlog Work Item:** {Link to the work item to provide more context}