Welcome to Engineering Guidance
This wiki is for gathering, organizing, and sharing approaches for creating content and code-based guidance.
Guidance Module Types (Short List)
This is a list of the most common types used in the patterns & practices guidance such as
Improving .NET Application Performance or
Whidbey Security Guidance .
*
Code Example *
Checklist Item *
Design Pattern *
Explained *
Guideline *
How To *
Implementation Pattern
Guidance Module Types Summary
*
At a Glance - Presents the essential information into a quick view.
*
Cheat Sheet - Presents reference information as a quick view.
*
Checklist Item - Present a verification to perform ("what to check for", "how to check" and "how to fix")
*
Code Example *
Explained - Explained exposes the what and how mechanics (e.g. how things work, basic architecture, design intentions, usage scenarios).
*
Guideline - Present the “what to do”, “why”, and “how”.
*
How To - How Tos are steps to execute an end to end task.
*
Practice - Brief problem and solution pairs that summarize solutions and link to more information.
*
Primer *
Reference Implementation *
Template - Give precise instructions. Show an example of what good looks like inline where possible. Include entry and exit criteria for key sections.
* Template Examples - Template Sample instantiates a template with an example of what a completed template would look like.
*
Walkthrough - Narrative walkthrough of the task or tasks. A “fly on the wall”observation of an activity.
*
Whiteboard Solution - Scenarios and Solutions provide fast before and after skeletal views of end to end application scenarios.
Templates for Writing Guidance
*
Activity Pattern Template *
Anti-Pattern Template *
Architecture Pattern *
Checklist Item *
Code Example *
Design Pattern *
Guideline *
How To *
Implementation Pattern *
Pattlet *
Scenario and Solution *
Techniqe *
Test Case *
Templates for Writing Guidance (Index)
Test Cases for Guidance
These are checkpoints that help both authors and reviewers produce more effective guidance.
*
Anti-Pattern Test Cases *
Checklist Item Test Cases *
Code Example Test Cases *
Design Pattern Test Cases *
Guideline Test Cases *
How To *
Implementation Pattern Test Cases *
Test Cases for Guidance
Guidance Module Types (Full List)
This section is for gathering, organizing, and sharing approaches for creating content-based guidance.
*
Activity Pattern *
Anti-Pattern *
Architectural Pattern *
Artifact Pattern *
At a Glance *
Cheat Sheet *
Checklist Item *
Code Example *
Design Pattern *
Explained *
FAQ *
Guideline *
How To *
Implementation Pattern *
Inspection Check *
Mini How To * "Pattlet":
Pattlet *
Pattern *
Principle *
Reference Implementation *
Roadmap *
Scenario and Solution *
Technique *
Technotes *
Template *
Test Case *
Walkthrough
Authoring
*
How To: Make a Scenario and Solution
Compositions
*
Creating Guides *
Creating a Guidelines Documents *
Creating a Checklist Document
Team Pages
*
p&p User Experience Guideline
Resources
*
Engineering Guidance Handbook *
Examples *
Guidance Module Compositions *
Guidance Modules Types *
Templates for Writing Guidance (Index)
*
HomePageArchive1 *
HomePageArchive2
