Skip to main content

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.

Jump to: navigation, search

Intent

Revision as of 08:54, 17 September 2013 by Alex.lagarde.obeo.fr (Talk | contribs)

Intent

Presentation

Intent is a newly proposed open source project under Mylyn. Intent 0.8 is available as part of the Eclipse Kepler Release Train.

The Mylyn Intent prime objective is to make developers consider documentation as something useful and easy to maintain, that they can use to formalize their best practices and share their knowledge. Based on a new vision of the documentation, in which explanations in natural langage are formally linked with technical artefacts (java code, models, manifest files, bugzilla issues, git repositories, etc.), Intent allows you to efficiently update documentation when a change occurs in your software, turning it into a true Agile documentation.

On top of that synchronization mechanism, Intent provides advanced tooling to write/query your documentation with everything you would expect from a modern IDE (completion, quick-fixes, quick-outlines allowing semantic searches...). Intent also allows live collaboration around documentation tasks.

The documentation, integrated with other Eclipse tools, then becomes truly useful and is no longer a burden that developers have to carry to please their customers or project manager.

Don't know where to start? Check out our useful links or the project summary.

Based on Donald Knuth's Literate Programming concepts and allowing collaborative work around design tasks, Intent was presented at Agile ALM connect 2013 and EclipseCon Europe 2012.

"Let us change our traditional attitude to the construction of programs: Instead of imagining that our main task is to instruct a computer what to do, let us concentrate rather on explaining to human beings what we want a computer to do."

Donald Knuth, Literate Programming (1984)


Intent Overview

The following pages provide an overview of the Intent project :


Getting Started


Getting Involved

The Intent Project

Obeo
Intent is an Eclipse based product created and developed by the Eclipse Strategic Member Obeo. It is aligned with Eclipse since the Eclipse Juno (4.2) release train.

Currently in incubation phase, it is part of the Mylyn's Docs project.


News


Back to the top