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 "Intent"
(21 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 | + | 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. |
− | + | 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. | |
− | Based on Donald | + | 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| | + | * [[Intent/Project mission statement|Mission Statement]] - General presentation |
− | * [[Intent/Videos| | + | * [[Intent/Architecture|Architecture]] - Design choices and extensibility |
− | * [[Intent/Use Cases|Use Cases and Scenarios]] - | + | * [[Intent/Videos|Demos]] - Intent demos (video clips included) |
− | + | * [[Intent/Use Cases|Use Cases and Scenarios]] - Step-by-step use cases with screenshots | |
− | * [[Intent/Plan|2012 | + | * [[Intent/Plan|2012 Release Plan]] - See what's planned for Intent 0.7 (Juno) |
− | * [[Intent/Buzz|Buzz]] - | + | * [[Intent/Buzz|Buzz]] - Articles and blogs about Intent |
− | * [[Intent/Useful_Links|Intent Useful links]] - | + | * [[Intent/Useful_Links|Intent Useful links]] - Useful links to understand what Intent is about |
{{Intent-footer}} | {{Intent-footer}} | ||
− | {{Intent-Header{{{watch|}}} | title= | + | {{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 45: | 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]] - | + | * [[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= | + | {{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 58: | 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/Extend_Intent| Customize and Extend Intent]] - Make Intent fit your needs | |
− | * [[Intent/Extend_Intent| Customize | + | * [[Intent/Further Readings|Further Readings]] - Books, articles and papers used to create Intent |
− | * [[Intent/Further Readings|Further Readings]] - | + | |
− | + | ||
{{Intent-footer}} | {{Intent-footer}} | ||
</div> | </div> | ||
Line 77: | Line 80: | ||
Currently in incubation phase, it is part of the [http://www.eclipse.org/mylyn/ Mylyn]'s ''Docs'' project. | Currently in incubation phase, it is part of the [http://www.eclipse.org/mylyn/ Mylyn]'s ''Docs'' project. | ||
− | [[Intent/ReleaseReview|See Intent Release Reviews]] | + | * [[Intent/ReleaseReview|See Intent Release Reviews]] |
{{Intent-footer}} | {{Intent-footer}} | ||
Line 87: | 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
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 :
- Mission Statement - General presentation
- Architecture - Design choices and extensibility
- Demos - Intent demos (video clips included)
- Use Cases and Scenarios - Step-by-step use cases with screenshots
- 2012 Release Plan - See what's planned for Intent 0.7 (Juno)
- Buzz - Articles and blogs about Intent
- Intent Useful links - Useful links to understand what Intent is about
Getting Started
- Intent Useful links - Useful links to understand what Intent is about
- User FAQ - Can't find the answer you're looking for? Just ask.
- Installation Guide - How to install Intent
- Tutorials - Tutorials to get started with Intent
Getting Involved
- Customize and Extend Intent - Make Intent fit your needs
- Further Readings - Books, articles and papers used to create Intent
The Intent Project
Currently in incubation phase, it is part of the Mylyn's Docs project.
News
- 04/04/2013 : Transcript of the Agile Documentation Talk - ECon Boston 2013
- 04/04/2013 : Transcript of the Documentation Driven Testing Talk - ECon Boston 2013
- 17/12/2012 : Intent presentation on Jaxenter
- 15/12/2012 : EclipseCon 2012 talk is available in video
- 05/11/2012 : New post : The Shape of Things to Come (Kepler roadmap)
- 26/10/2012 : Transcript of the EclipseCon Europe 2012 talk
- 28/06/2012 : Video Record of the Intent talk at Eclipse DemoCamp Juno is available (in french)
- 27/06/2012 : Intent 0.7 released with Juno Release Train
- 04/04/2012 : Transcript of the Agile ALM 2012 talk
- 02/12/2011 : Intent will be at Agile ALM Connect 2011
- 08/11/2011 : Transcript of the EclipseCon Europe 2011 talk
- 04/11/2011 : Intent will be at EclipseCon Europe 2011
- 02/09/2011 : Intent Nightly Builds in place
- 04/07/2011 : Intent is now on github
- 11/04/2011 : Intent website has been created
- 22/03/2011 : Talk at Eclipse con : Mylyn meets Intent...
- 17/03/2011 : Intent Creation Review succeeded
- New post : Mylyn Intent @ EclipseCon 2011
- 01/02/2011 : Intent proposal has been published
- 27/12/2010 : Intent will be at Eclipse Con 2011
- New post : Intent Discovery - Part 1 : the intents behind softwares