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 "Papyrus/Papyrus Developer Guide/Writing Documentation"
(New page: == How to - Write documentation for Papyrus == Documentation should be accessible online and in the documentation embedded in Eclipse platform. Both places should be coherent, so a common...) |
(→Creating the first version of the documentation) |
||
| Line 3: | Line 3: | ||
Documentation should be accessible online and in the documentation embedded in Eclipse platform. Both places should be coherent, so a common format is used. | Documentation should be accessible online and in the documentation embedded in Eclipse platform. Both places should be coherent, so a common format is used. | ||
| − | === | + | === Writing the first version of the documentation === |
The document should be initialized as a page in the wiki, using mediawiki syntax. A rich editor is accessible from wiki pages, so a nice documentation can be writtten. | The document should be initialized as a page in the wiki, using mediawiki syntax. A rich editor is accessible from wiki pages, so a nice documentation can be writtten. | ||
The following page can be used as example: [http://wiki.eclipse.org/MDT/Papyrus/UserGuide/Search User Guide / Search] | The following page can be used as example: [http://wiki.eclipse.org/MDT/Papyrus/UserGuide/Search User Guide / Search] | ||
Revision as of 13:07, 22 February 2013
How to - Write documentation for Papyrus
Documentation should be accessible online and in the documentation embedded in Eclipse platform. Both places should be coherent, so a common format is used.
Writing the first version of the documentation
The document should be initialized as a page in the wiki, using mediawiki syntax. A rich editor is accessible from wiki pages, so a nice documentation can be writtten. The following page can be used as example: User Guide / Search