Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "UI Best Practices Template v3.x"
(→Topic Name) |
|||
| Line 1: | Line 1: | ||
| − | = | + | = Proposed Template Revision 1 = |
== Topic Name == | == Topic Name == | ||
=== Title === | === Title === | ||
| − | <Summary and | + | <Content of this section includes Summary and Problem Description type information.> |
=== Design Rationale === | === Design Rationale === | ||
| Line 10: | Line 10: | ||
=== Examples === | === Examples === | ||
< This is a good place for Common Errors with related examples as well as Tips and Tricks its often examples, so maybe just call it examples. This makes it easier for those to contribute since design v.s. in practice is easier to explain.> | < This is a good place for Common Errors with related examples as well as Tips and Tricks its often examples, so maybe just call it examples. This makes it easier for those to contribute since design v.s. in practice is easier to explain.> | ||
| + | |||
| + | * Good example 1 | ||
| + | |||
| + | * Good example 2 | ||
| + | |||
| + | * Common error example 1 | ||
| + | |||
| + | * Common error example 2 | ||
| + | |||
| + | * Tip and trick 1 | ||
| + | |||
| + | * Tip and trick 2 | ||
=== Guidelines === | === Guidelines === | ||
| − | <Do's and Dont's> | + | <This is a list of Do's and Dont's> |
=== Related Information === | === Related Information === | ||
<This is for links to related information internal or external to the guidelines and to areas of the 2.1 guidelines that your best practice extends. Provide as direct links as possible.> | <This is for links to related information internal or external to the guidelines and to areas of the 2.1 guidelines that your best practice extends. Provide as direct links as possible.> | ||
| + | |||
| + | |||
| + | = Proposed Template Revision 2 = | ||
| + | == Topic Name == | ||
| + | === Title === | ||
| + | <Content of this section includes Summary and Problem Description type information.> | ||
| + | * Summary is a single active and concise statement describing what to do to follow the best practice. It should start with a verb. | ||
| + | * Problem Descriptionis short 1 – 3 paragraph description of the problem. | ||
| + | |||
| + | === Design Rationale === | ||
| + | <This describes the thinking behind the design and the best practices to solve the problem.> | ||
| + | |||
| + | === Examples === | ||
| + | <This shows good examples, common errors, and tips and tricks.> | ||
| + | |||
| + | * Good example 1 | ||
| + | |||
| + | * Good example 2 | ||
| + | |||
| + | * Common error example 1 | ||
| + | |||
| + | * Common error example 2 | ||
| + | |||
| + | * Tip and trick 1 | ||
| + | |||
| + | * Tip and trick 2 | ||
| + | |||
| + | === Guidelines === | ||
| + | <This is a list of Do's and Dont's> | ||
| + | |||
| + | === Implementation === | ||
| + | <This offers information for implementing the solution. It could be a link to the API code for example, or some instructions.> | ||
| + | |||
| + | * Sample code 1 | ||
| + | |||
| + | * Sample code 2 | ||
| + | |||
| + | === Related Information === | ||
| + | <This is for links to related information internal or external to the guidelines and to areas of the 2.1 guidelines that your best practice extends. Provide as direct links as possible.> | ||
| + | |||
| − | = | + | = Current Template = |
== Topic Name == | == Topic Name == | ||
=== Summary === | === Summary === | ||
| − | |||
<This is a single active and concise statement describing what to do to follow the best practice. It should start with a verb.> | <This is a single active and concise statement describing what to do to follow the best practice. It should start with a verb.> | ||
=== Problem Description === | === Problem Description === | ||
| − | |||
<This is short 1 – 3 paragraph description of the problem.> | <This is short 1 – 3 paragraph description of the problem.> | ||
=== Best Practice === | === Best Practice === | ||
| − | |||
<This lists and describes the best practices or best practices in solve the problem.> | <This lists and describes the best practices or best practices in solve the problem.> | ||
| Line 38: | Line 87: | ||
==== Common Errors ==== | ==== Common Errors ==== | ||
| − | |||
| − | + | * Example 1 | |
| − | + | * Example 2 | |
=== Implementation === | === Implementation === | ||
<This offers information for implementing the solution. It could be a link to the API code for example, or some instructions.> | <This offers information for implementing the solution. It could be a link to the API code for example, or some instructions.> | ||
| − | Sample code 1 | + | * Sample code 1 |
| − | Sample code 2 | + | * Sample code 2 |
=== Related Information === | === Related Information === | ||
<This is for links to related information internal or external to the guidelines and to areas of the 2.1 guidelines that your best practice extends. Provide as direct links as possible.> | <This is for links to related information internal or external to the guidelines and to areas of the 2.1 guidelines that your best practice extends. Provide as direct links as possible.> | ||
Revision as of 16:23, 28 March 2007
Proposed Template Revision 1
Topic Name
Title
<Content of this section includes Summary and Problem Description type information.>
Design Rationale
<This describes the thinking behind the design and the best practices to solve the problem.>
Examples
< This is a good place for Common Errors with related examples as well as Tips and Tricks its often examples, so maybe just call it examples. This makes it easier for those to contribute since design v.s. in practice is easier to explain.>
- Good example 1
- Good example 2
- Common error example 1
- Common error example 2
- Tip and trick 1
- Tip and trick 2
Guidelines
<This is a list of Do's and Dont's>
Related Information
<This is for links to related information internal or external to the guidelines and to areas of the 2.1 guidelines that your best practice extends. Provide as direct links as possible.>
Proposed Template Revision 2
Topic Name
Title
<Content of this section includes Summary and Problem Description type information.>
- Summary is a single active and concise statement describing what to do to follow the best practice. It should start with a verb.
- Problem Descriptionis short 1 – 3 paragraph description of the problem.
Design Rationale
<This describes the thinking behind the design and the best practices to solve the problem.>
Examples
<This shows good examples, common errors, and tips and tricks.>
- Good example 1
- Good example 2
- Common error example 1
- Common error example 2
- Tip and trick 1
- Tip and trick 2
Guidelines
<This is a list of Do's and Dont's>
Implementation
<This offers information for implementing the solution. It could be a link to the API code for example, or some instructions.>
- Sample code 1
- Sample code 2
Related Information
<This is for links to related information internal or external to the guidelines and to areas of the 2.1 guidelines that your best practice extends. Provide as direct links as possible.>
Current Template
Topic Name
Summary
<This is a single active and concise statement describing what to do to follow the best practice. It should start with a verb.>
Problem Description
<This is short 1 – 3 paragraph description of the problem.>
Best Practice
<This lists and describes the best practices or best practices in solve the problem.>
Tips and Tricks
<This offers tips and tricks for solving the problem.>
Common Errors
- Example 1
- Example 2
Implementation
<This offers information for implementing the solution. It could be a link to the API code for example, or some instructions.>
- Sample code 1
- Sample code 2
Related Information
<This is for links to related information internal or external to the guidelines and to areas of the 2.1 guidelines that your best practice extends. Provide as direct links as possible.>