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/ProjectDetails"
m |
|||
| Line 14: | Line 14: | ||
Due to the students limited existing knowledge of the platform as well as relatively short time constraints, it would be unfeasible to assume they could be the single source/aggregator of all relevant and applicable knowledge relating to the services. Given that the Eclipse community is such a vibrant, active and highly motivated community the students will open up the process of documenting the services and reach out to the community for help. The process is as follows: | Due to the students limited existing knowledge of the platform as well as relatively short time constraints, it would be unfeasible to assume they could be the single source/aggregator of all relevant and applicable knowledge relating to the services. Given that the Eclipse community is such a vibrant, active and highly motivated community the students will open up the process of documenting the services and reach out to the community for help. The process is as follows: | ||
| − | # On a service by service basis, compile as much knowledge as possible, following the [[ | + | # On a service by service basis, compile as much knowledge as possible, following the [[../Template|template]]. |
# Reach out to the community through newsgroups, forums etc. to make them aware of the documentation and request for feedback. | # Reach out to the community through newsgroups, forums etc. to make them aware of the documentation and request for feedback. | ||
# Compile the feedback and put it into the wiki | # Compile the feedback and put it into the wiki | ||
Revision as of 14:58, 12 February 2010
Project Definition
The development of Eclipse e4's application services documentation is a collaborative effort between a team of computer science students at the University of Manitoba and the wider Eclipse community.
The students involved in this project have chosen to contribute to Eclipse as part of an upper-year technical communications course in which they are enrolled. Their involvement will continue until the end of April 2010, during which time they will act as project facilitators. Their efforts will be two-fold: they will write and edit documentation to the extent that their understanding of e4 allows, and they will actively solicit the Eclipse community for assistance.
Medium
Development of the documentation occurs on this wiki. Upon finalization, the wiki pages will likely be converted into the Eclipse Help format.
A list of existing wiki pages is kept here. The documentation for each application service resides in its own page and conforms to this template.
Process
Due to the students limited existing knowledge of the platform as well as relatively short time constraints, it would be unfeasible to assume they could be the single source/aggregator of all relevant and applicable knowledge relating to the services. Given that the Eclipse community is such a vibrant, active and highly motivated community the students will open up the process of documenting the services and reach out to the community for help. The process is as follows:
- On a service by service basis, compile as much knowledge as possible, following the template.
- Reach out to the community through newsgroups, forums etc. to make them aware of the documentation and request for feedback.
- Compile the feedback and put it into the wiki
- Repeat as necessary.
The goal is to have a community developed documentation with large input from the people who are actually developing the services! This is an interesting communication and collaboration challenge but also interesting from the point of view as it is a step away from the typical way projects are documented.
Collaborators
- A team of University of Manitoba students
- Brent Barkman
- Stefan Dimitrov
- Chris Hildebrand