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

Difference between revisions of "Intent"

(31 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
[[Image:Intent_logo.png|center|Intent|400px]]
 +
 
{{Intent-Header{{{watch|}}} | title=Presentation
 
{{Intent-Header{{{watch|}}} | title=Presentation
 
|editpage=Intent
 
|editpage=Intent
Line 6: Line 8:
 
|background=#f0edf8      <!-- H120 S4 V100 the color of the Box Section background -->
 
|background=#f0edf8      <!-- H120 S4 V100 the color of the Box Section background -->
 
|foreground=black}}      <!-- This is the color of the Box Section text -->
 
|foreground=black}}      <!-- This is the color of the Box Section text -->
Intent is a proposed new open source project under the [[Mylyn]] top-level project. [[Intent/Installation_Guide|Intent 0.7 M6]] is available as part of Eclipse Juno Release Train.
+
Intent is a newly proposed open source project under [[Mylyn]]. [[Intent/Installation_Guide|Intent 0.7]] is available as part of the Eclipse Juno Release Train, and Intent 0.8 will be released with Eclipse Kepler.
  
Don't know where to start ? Check our [[Intent/Useful_Links|useful links]] or check [http://www.eclipse.org/projects/project.php?id=mylyn.docs.intent Intent project summary].
+
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.
  
The main purpose of Intent is to allow 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.
+
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.  
  
Based on Donald Knuth’s Literate Programming concepts and allowing collaborative work around design tasks, Intent was presented at [http://www.eclipse.org/intent/pages/transcripts/2012_AgileALMConnect/Intent_AgileALMConnect2012.htm Agile ALM connect 2012].
+
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 [[Intent/Useful_Links|useful links]] or the [http://www.eclipse.org/projects/project.php?id=mylyn.docs.intent project summary].
 +
 
 +
Based on Donald Knuth's Literate Programming concepts and allowing collaborative work around design tasks, Intent was presented at [http://www.eclipse.org/intent/pages/transcripts/2013_EclipseConBoston/Intent_EConBoston2013.html#1 Agile ALM connect 2013] and [http://www.eclipse.org/intent/pages/transcripts/2012_EclipseConEurope/Intent_EConEurope2012.html#1 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."''
 
''"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."''
Line 27: Line 33:
 
|background=#f0edf8      <!-- H120 S4 V100 the color of the Box Section background -->
 
|background=#f0edf8      <!-- H120 S4 V100 the color of the Box Section background -->
 
|foreground=black}}      <!-- This is the color of the Box Section text -->
 
|foreground=black}}      <!-- This is the color of the Box Section text -->
 
 
The following pages provide an overview of the Intent project :  
 
The following pages provide an overview of the Intent project :  
* [[Intent/Project mission statement|Project mission statement]] - general presentation of Intent
+
* [[Intent/Project mission statement|Mission Statement]] - General presentation
* [[Intent/Use Cases|Use Cases and Scenarios]] - step by step use cases with screenshots
+
* [[Intent/Architecture|Architecture]] - Design choices and extensibility
* [[Intent/Architecture|Architecture]] - design choices and extensibility
+
* [[Intent/Videos|Demos]] - Intent demos (video clips included)
* [[Intent/Plan|2011 release plan]] - what we intend to do for the first Intent release
+
* [[Intent/Use Cases|Use Cases and Scenarios]] - Step-by-step use cases with screenshots
* [[Intent/Buzz|Buzz]] - articles and blog posts about Intent
+
* [[Intent/Plan|2012 Release Plan]] - See what's planned for Intent 0.7 (Juno)
 +
* [[Intent/Buzz|Buzz]] - Articles and blogs about Intent
 +
* [[Intent/Useful_Links|Intent Useful links]] - Useful links to understand what Intent is about
 
{{Intent-footer}}
 
{{Intent-footer}}
  
{{Intent-Header{{{watch|}}} | title=Get Started
+
{{Intent-Header{{{watch|}}} | title=Getting Started
 
|editpage=Intent
 
|editpage=Intent
 
|border= #C3C3E5          <!-- H120 S15 V75 the color of the borders around Box Sections -->
 
|border= #C3C3E5          <!-- H120 S15 V75 the color of the borders around Box Sections -->
Line 43: Line 50:
 
|background=#f0edf8      <!-- H120 S4 V100 the color of the Box Section background -->
 
|background=#f0edf8      <!-- H120 S4 V100 the color of the Box Section background -->
 
|foreground=black}}      <!-- This is the color of the Box Section text -->
 
|foreground=black}}      <!-- This is the color of the Box Section text -->
* [[Intent/FAQ|User FAQ]] - if the answer your are looking for is not here, just ask the question
+
* [[Intent/Useful_Links|Intent Useful links]] - Useful links to understand what Intent is about
 +
* [[Intent/FAQ|User FAQ]] - Can't find the answer you're looking for? Just ask.
 
* [[Intent/Installation_Guide|Installation Guide]] - How to install Intent
 
* [[Intent/Installation_Guide|Installation Guide]] - How to install Intent
 
* [[Intent/Getting_Started|Tutorials]] - Tutorials to get started with Intent
 
* [[Intent/Getting_Started|Tutorials]] - Tutorials to get started with Intent
 
{{Intent-footer}}
 
{{Intent-footer}}
  
{{Intent-Header{{{watch|}}} | title=Get involved
+
{{Intent-Header{{{watch|}}} | title=Getting Involved
 
|editpage=Intent
 
|editpage=Intent
 
|border= #C3C3E5          <!-- H120 S15 V75 the color of the borders around Box Sections -->
 
|border= #C3C3E5          <!-- H120 S15 V75 the color of the borders around Box Sections -->
Line 55: Line 63:
 
|background=#f0edf8      <!-- H120 S4 V100 the color of the Box Section background -->
 
|background=#f0edf8      <!-- H120 S4 V100 the color of the Box Section background -->
 
|foreground=black}}      <!-- This is the color of the Box Section text -->
 
|foreground=black}}      <!-- This is the color of the Box Section text -->
* [[Intent/FAQ|Developper FAQ]] - if the answer your are looking for is not here, just ask the question
+
* [[Intent/Extend_Intent| Customize and Extend Intent]] - Make Intent fit your needs
* [[Intent/Extend_Intent| Customize & extend Intent behavior]] - learn how to extend Intent to fit your needs
+
* [[Intent/Further Readings|Further Readings]] - Books, articles and papers used to create Intent
* [[Intent/Further Readings|Further Readings]] - books, articles and scientific papers used to create Intent
+
 
{{Intent-footer}}
 
{{Intent-footer}}
 
</div>
 
</div>
Line 69: Line 76:
 
|background=#f0edf8      <!-- H120 S4 V100 the color of the Box Section background -->
 
|background=#f0edf8      <!-- H120 S4 V100 the color of the Box Section background -->
 
|foreground=black}}      <!-- This is the color of the Box Section text -->
 
|foreground=black}}      <!-- This is the color of the Box Section text -->
[[Image:Logo obeo.png|left|Obeo|100px]]Intent is an Eclipse based product created and developed by the Eclipse Strategic Member [http://www.obeo.fr/index.php?lang=en Obeo]. It is meant to be aligned with the Eclipse release train of Eclipse 3.8 (Juno).
+
[[Image:Logo obeo.png|left|Obeo|100px]]Intent is an Eclipse based product created and developed by the Eclipse Strategic Member [http://www.obeo.fr/index.php?lang=en Obeo]. It is aligned with the Eclipse Juno (4.2) release train.
 +
 
 +
Currently in incubation phase, it is part of the [http://www.eclipse.org/mylyn/ Mylyn]'s ''Docs'' project.
  
Currently in incubation phase, it is meant to be released under the [http://www.eclipse.org/mylyn/ Mylyn]'s ''Docs'' project.
+
* [[Intent/ReleaseReview|See Intent Release Reviews]]
 
{{Intent-footer}}
 
{{Intent-footer}}
  
Line 81: Line 90:
 
|background=#f0edf8      <!-- H120 S4 V100 the color of the Box Section background -->
 
|background=#f0edf8      <!-- H120 S4 V100 the color of the Box Section background -->
 
|foreground=black}}      <!-- This is the color of the Box Section text -->
 
|foreground=black}}      <!-- This is the color of the Box Section text -->
 +
* 04/04/2013 : [http://www.eclipse.org/intent/pages/transcripts/2013_EclipseConBoston/Intent_EConBoston2013.html#1 Transcript of the Agile Documentation Talk - ECon Boston 2013]
 +
* 04/04/2013 : [http://www.eclipse.org/intent/pages/transcripts/2013_EclipseConBoston_DDT/DocDrivenTesting_EconBoston2013.html#1 Transcript of the Documentation Driven Testing Talk - ECon Boston 2013]
 +
* 17/12/2012 : [http://jaxenter.com/eclipse-intent-being-agile-does-not-mean-being-short-sighted-45856.html Intent presentation on Jaxenter]
 +
* 15/12/2012 : EclipseCon 2012 talk is [http://www.youtube.com/watch?feature=player_embedded&v=MNo_0HYh8aI available in video]
 +
* 05/11/2012 : New post : [http://alagarde.tumblr.com/post/34825775217/mylyn-intent-the-shape-of-things-to-come The Shape of Things to Come (Kepler roadmap)]
 +
* 26/10/2012 : [http://www.eclipse.org/intent/pages/transcripts/2012_EclipseConEurope/Intent_EConEurope2012.html#1 Transcript of the EclipseCon Europe 2012 talk]
 +
* 28/06/2012 : [http://www.youtube.com/watch?v=w7kUsQu6zog&feature=youtu.be&t=18m29s Video Record of the Intent talk] at [http://wiki.eclipse.org/Eclipse_DemoCamps_Juno_2012/Nantes Eclipse DemoCamp Juno] is available (in french)
 +
* 27/06/2012 : Intent 0.7 released with Juno Release Train
 
* 04/04/2012 : [http://www.eclipse.org/intent/pages/transcripts/2012_AgileALMConnect/Intent_AgileALMConnect2012.htm Transcript of the Agile ALM 2012 talk]
 
* 04/04/2012 : [http://www.eclipse.org/intent/pages/transcripts/2012_AgileALMConnect/Intent_AgileALMConnect2012.htm Transcript of the Agile ALM 2012 talk]
 
* 02/12/2011 : Intent will be at [http://www.eclipsecon.org/2012/sessions/create-useful-documentation-mylyn-intent-step-further-application-life-cycle-management  Agile ALM Connect 2011]
 
* 02/12/2011 : Intent will be at [http://www.eclipsecon.org/2012/sessions/create-useful-documentation-mylyn-intent-step-further-application-life-cycle-management  Agile ALM Connect 2011]

Revision as of 11:01, 11 April 2013

Intent

Presentation

Intent is a newly proposed open source project under Mylyn. Intent 0.7 is available as part of the Eclipse Juno Release Train, and Intent 0.8 will be released with Eclipse Kepler.

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 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