Intent

Root

Discover

Intent : tooling for writing useful and synchronized documentation Intent is a tool allowing developers to easily write a documentation up-to-date with any development artifact (models, code, environment...). The documentation, integrated with other Eclipse tools, then becomes truly useful and is no longer a burden that developer have to carry to please their customers or their project manager. Based on Donald Knuth's Literate Programming concepts and allowing collaborative work around design tasks, Intent will try to reconcile developers with Documentation. Intent will be released under the Mylyn top-level project, and is planned to be fully integrated with Mylyn tools. This project was just provisioned. You can see the proposal here, and get additional informations on the Intent's Wiki.

Forums:

eclipse.intent [nntp]

Come here to participate in technical and general discussions about Intent.

Engage

Engage with the project. Get the code. Build products based on this technology.

Scope:

This project is focused on providing an editing environment to author documentations mixing natural and formal language, easing the application life-cycle management by capturing the intents and design choices made during development. Specific integration will be provided with existing Eclipse projects to retrieve and synchronize the development artifacts with the formal descriptions. The Intent project will focus on providing an extensible framework and actively solicit contributions in this regard. in scope :

Tools for creating documentation mixing a formal and non-formal syntax
Tools for collaborating on top of such documentations
Tools for editing, validating the documentation
Tools for synchronizing the documentation regarding the development artifacts

out of scope :

Tooling and framework to create domain specific languages
Specific support for documentation formats and syntaxes (see wikitext).
Reusable UI components for documentation or rich text editing.
Documentation file format interoperability

Contribute to this project:

Create a new bug/issue report

You can use the code from these repositories to experiment, test, build, create patches, issue pull requests, etc.

mylyn.docs.intent.main

Clone this repository:

git://git.eclipse.org/gitroot/intent/org.eclipse.mylyn.docs.intent.main.git
ssh://userid@git.eclipse.org/gitroot/intent/org.eclipse.mylyn.docs.intent.main.git