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"
(→UI Best Practices Template File) |
|||
| Line 1: | Line 1: | ||
| − | ==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.> | ||
| − | Tips and Tricks | + | ==== Tips and Tricks ==== |
<This offers tips and tricks for solving the problem.> | <This offers tips and tricks for solving the problem.> | ||
| − | Common Errors | + | ==== Common Errors ==== |
<This offers tips and tricks for solving the problem.> | <This offers tips and tricks for solving the problem.> | ||
| − | Good example 1 | + | Good example 1 |
Good example 2 | Good 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 13:10, 24 January 2007
Contents
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
<This offers tips and tricks for solving the problem.>
Good example 1
Good 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.>