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 "E4/Doc/Template"
| Line 1: | Line 1: | ||
| + | <!-- Delete from here to End Delete marker when actually using this template --> | ||
| + | ==HOW TO USE THIS TEMPLATE == | ||
| + | Navigate to the URL of the service you wish to document. If it does not exist yet, the wiki will bring you to a blank page that you can start working with. Choose the edit tab and copy and paste this markup in. Replace the text for each section will the relevant service information and be sure to delete this subsection. | ||
| + | <!-- End Delete --> | ||
{{E4/Doc/Under construction}} | {{E4/Doc/Under construction}} | ||
| − | + | <!-- you may want to remove the above templated banner --> | |
[[Image:Service diagram.jpg|thumb|alt=Diagram of services in E4.|A placeholder diagram.]] | [[Image:Service diagram.jpg|thumb|alt=Diagram of services in E4.|A placeholder diagram.]] | ||
| − | + | <!-- ALWAYS LEAVE THE LEGEND WHEN THERE'S A DIAGRAM AND FOLLOW IT --> | |
| + | [[Image:E4_legend.png|thumb|alt=Legend|Legend]] | ||
Both a general and eclipse-centric description go here. | Both a general and eclipse-centric description go here. | ||
| Line 8: | Line 13: | ||
* List - and description of | * List - and description of | ||
* Relevant Terms - goes here | * Relevant Terms - goes here | ||
| + | * Things - like Eclipse'isms or terms that would be useful and commonly found in discussion about this service both generally or Eclipse specifically | ||
== Motivation == | == Motivation == | ||
| − | What problem does this service solve? What's the use case that it makes easier? | + | What problem does this service solve? What's the use case that it makes easier? Essentially the WHY behind the service. |
== Applicability == | == Applicability == | ||
| − | Where does it apply? | + | Where does it apply? What situations is it useful in? DO NOT mention code or api here. The goal is to be code agnostic. |
== Implementation == | == Implementation == | ||
The details surrounding actually consuming or contributing to the service as well as tips and tricks. | The details surrounding actually consuming or contributing to the service as well as tips and tricks. | ||
| − | This is also where the code samples will live if there are any | + | This is also where the code samples will live if there are any however USE SPARINGLY and only when they are the best way to convey a point. The goal of this documentation is to be code agnostic. |
<source lang="java"> | <source lang="java"> | ||
| Line 29: | Line 35: | ||
== Related Services == | == Related Services == | ||
| − | *A hyper-linked list of related services | + | *A hyper-linked list of related services that will provide the reader with relevant information when they are consuming this particular service. |
| + | |||
| + | == Unrelated Services == | ||
| + | *It is rare that this section will be needed but in the case where two services appear to be very similar but in fact are very different, you should list and describe it here. | ||
Revision as of 16:29, 11 April 2010
Contents
HOW TO USE THIS TEMPLATE
Navigate to the URL of the service you wish to document. If it does not exist yet, the wiki will bring you to a blank page that you can start working with. Choose the edit tab and copy and paste this markup in. Replace the text for each section will the relevant service information and be sure to delete this subsection.
The evolution of this document is a collaborative effort between a team of students at the University of Manitoba and the wider Eclipse community. Details about the project can be found here and on our Blog.
Your input is not just welcome; it is needed! Please contribute as your expertise allows, while adhering to our template. To send your feedback and any questions or comments you may have please email us. Also, while we do our very best to be as accurate and precise as possible, it is worth noting that we are students with limited exposure to the Eclipse platform, so if you see any incorrect technical details please let us know.
Both a general and eclipse-centric description go here.
Relevant Terms
- List - and description of
- Relevant Terms - goes here
- Things - like Eclipse'isms or terms that would be useful and commonly found in discussion about this service both generally or Eclipse specifically
Motivation
What problem does this service solve? What's the use case that it makes easier? Essentially the WHY behind the service.
Applicability
Where does it apply? What situations is it useful in? DO NOT mention code or api here. The goal is to be code agnostic.
Implementation
The details surrounding actually consuming or contributing to the service as well as tips and tricks.
This is also where the code samples will live if there are any however USE SPARINGLY and only when they are the best way to convey a point. The goal of this documentation is to be code agnostic.
@Inject MSomething; public void foo() { }
Related Services
- A hyper-linked list of related services that will provide the reader with relevant information when they are consuming this particular service.
- It is rare that this section will be needed but in the case where two services appear to be very similar but in fact are very different, you should list and describe it here.