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 * === | ||
| + | == Topic Name == | ||
| + | |||
| + | === Title === | ||
| + | <Summary and problem description are just paragraphs under the title> | ||
| + | |||
| + | === 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.> | ||
| + | |||
| + | === Guidelines === | ||
| + | <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.> | ||
| + | |||
| + | |||
| + | |||
| + | === * Current Template * === | ||
== Topic Name == | == Topic Name == | ||
=== Summary === | === Summary === | ||
| + | <<<Propose subsetting text for this under Title>>> | ||
<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 === | ||
| + | <<<Propose subsetting text for this under Title>>> | ||
<This is short 1 – 3 paragraph description of the problem.> | <This is short 1 – 3 paragraph description of the problem.> | ||
=== Best Practice === | === Best Practice === | ||
| + | <<<Propose changing to Guidelines>>> | ||
<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 14: | Line 38: | ||
==== Common Errors ==== | ==== Common Errors ==== | ||
| − | < | + | <<<Propose changing to Examples>>> |
Good example 1 | Good example 1 | ||
Revision as of 13:04, 28 March 2007
* Proposed Template Revision *
Topic Name
Title
<Summary and problem description are just paragraphs under the title>
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.>
Guidelines
<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.>
* Current Template *
Topic Name
Summary
<<<Propose subsetting text for this under Title>>> <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
<<<Propose subsetting text for this under Title>>> <This is short 1 – 3 paragraph description of the problem.>
Best Practice
<<<Propose changing to Guidelines>>> <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
<<<Propose changing to Examples>>>
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.>