Documentation Overhaul DoW - Revision history

imported>Jastram: /* Forth Iteration */

2011-12-08T12:41:25Z

Forth Iteration

← Older revision		Revision as of 12:41, 8 December 2011
Line 138:		Line 138:
	== Forth Iteration ==		== Forth Iteration ==

	=== WP4-1: ~~Completion of the Reference Section~~ (~~40h~~) ===		=== WP4-1: Improve Tutorial Chapters 2.9 and 2.10 (20h) ===

	~~The time so far was almost certainly~~ not ~~enough to finish~~ the reference section.		These chapters concern the celebrity problem and location access controller, and are not as well developed as the rest of the tutorial.

			'''Deliverable:''' Improved Chapters 2.9 and 2.19.

			=== WP4-2: Completion of the Reference Section (20h) ===

			There are still some open tasks in the reference section.

	'''Deliverable:''' Complete Reference Section.		'''Deliverable:''' Complete Reference Section.

	=== WP4-2: Polishing (~~90h~~) ===		=== WP4-3: References and "Further Reading" Sections in Tutorial (30h) ===

			We need a tighter integration between tutorial and reference section. We will achieve this by providing more references into the reference section, and by providing a "Further Reading" section that points to the reference section and possibly to literature.

			'''Deliverable:''' New subsections in each section of the tutorial, more references.

			=== WP4-4: Coordination with Systerel to make the Rodin Handbook part of the Distribution (20h) ===

			Currently, the handbook has to be installed manually into Rodin. We will coordinate with Systerel to make sure that the next version of Rodin will ship with the handbook already installed. We also plan to do some minor modifications on our build infrastructure.

			'''Deliverable:''' Rodin with Handbook.

			=== WP4-5: Polishing (40h) ===

	~~Polishing~~, ~~as decided at~~ the ~~last review~~.		Some screenshots and images still have to be improved, and general improvement of the text flow. Also, we will keep collecting and processing feedback from users.

	'''Deliverable:''' Complete Documentation.		'''Deliverable:''' Complete Documentation.

	=== WP4-3: Final Review (30mh) ===		=== WP4-6: Final Review (30mh) ===

	In addition to reviewing the last iteration, we will record feedback on the project as a whole.		In addition to reviewing the last iteration, we will record feedback on the project as a whole.

imported>Jastram: /* Third Iteration */

2011-12-08T11:53:33Z

Third Iteration

← Older revision		Revision as of 11:53, 8 December 2011
Line 120:		Line 120:
	'''Deliverable:''' [http://handbook.event-b.org/review-3/html/ Improved documentation]		'''Deliverable:''' [http://handbook.event-b.org/review-3/html/ Improved documentation]

	=== WP3-5: Remove migrated content from Wiki (~~30h~~) ===		=== WP3-5: Remove migrated content from Wiki (20h) ===

	Eventually, we want to remove migrated content from the Wiki to prevent outdated information. At the same time, we will create a tighter integration between handbook web site and the Rodin Wiki. We'll also visit every single wiki page and if there is ambiguity on where the content should reside, we'll track down the owner and figure it out.		Eventually, we want to remove migrated content from the Wiki to prevent outdated information. At the same time, we will create a tighter integration between handbook web site and the Rodin Wiki. We'll also visit every single wiki page and if there is ambiguity on where the content should reside, we'll track down the owner and figure it out.
Line 126:		Line 126:
	'''Deliverable:''' [http://wiki.event-b.org/ Cleaned-up Wiki].		'''Deliverable:''' [http://wiki.event-b.org/ Cleaned-up Wiki].

	=== WP3-6: Iteration Review (20mh) ===		=== WP3-6: Creation of an index (10mh) ===

			An index will be created, for two reasons: First, in the print version, this will be a useful tool in addition to cross references and the table of contents. Second, it will allow the location of topics where the search functionality is simply inadequate (e.g. mathematical symbols, words like "where").

			'''Deliverable:''' [http://handbook.event-b.org/review-3/html/sect0037.html Index].

			=== WP3-7: Iteration Review (20mh) ===

	The last iteration will be used for “polishing” In this review, we allocate the resources as needed.		The last iteration will be used for “polishing” In this review, we allocate the resources as needed.

imported>Jastram: /* Third Iteration */

2011-12-08T11:43:56Z

Third Iteration

← Older revision		Revision as of 11:43, 8 December 2011
Line 100:		Line 100:
	The goal is to fill in all blanks in the reference section at this point. We may keep a list of entries that need improvements.		The goal is to fill in all blanks in the reference section at this point. We may keep a list of entries that need improvements.

	'''Deliverable:''' Complete Reference Section.		'''Deliverable:''' [http://handbook.event-b.org/review-3/html/reference.html Complete Reference Section].

	=== WP3-2: User Tests of Tutorial (40mh) ===		=== WP3-2: User Tests of Tutorial (40mh) ===
Line 106:		Line 106:
	We will offer a B block course in fall 2011 in Düsseldorf, where the students will learn classical B (not Event-B). They will get a class project in Event-B. They will have to teach themselves Event-B using the tutorial, in order to solve their assignment. We will monitor the progress, collect feedback and identify overall weaknesses in the tutorial. We expect a group of 5-10 students.		We will offer a B block course in fall 2011 in Düsseldorf, where the students will learn classical B (not Event-B). They will get a class project in Event-B. They will have to teach themselves Event-B using the tutorial, in order to solve their assignment. We will monitor the progress, collect feedback and identify overall weaknesses in the tutorial. We expect a group of 5-10 students.

	'''Deliverable:''' Results of the user tests		'''Deliverable:''' [http://handbook.event-b.org/review-3/2011_12_08_Handbook_Survey.pdf Results of the user tests]

	=== WP3-3: Completion of the Tutorial (20mh) ===		=== WP3-3: Completion of the Tutorial (20mh) ===
Line 112:		Line 112:
	We will incorporate the feedback from the review.		We will incorporate the feedback from the review.

	'''Deliverable:''' Complete Tutorial.		'''Deliverable:''' [http://handbook.event-b.org/review-3/html/tutorial.html Complete Tutorial].

	=== WP3-4: Provide context to give the documentation a whole appearance (20mh) ===		=== WP3-4: Provide context to give the documentation a whole appearance (20mh) ===
Line 118:		Line 118:
	At this point, we will pay attention to the document “as a whole”. We will make sure all sections have proper introductions, check the style, etc. We will also create a list of sections that need particular attention.		At this point, we will pay attention to the document “as a whole”. We will make sure all sections have proper introductions, check the style, etc. We will also create a list of sections that need particular attention.

	'''Deliverable:''' Improved documentation~~, List of trouble spots.~~		'''Deliverable:''' [http://handbook.event-b.org/review-3/html/ Improved documentation]

	=== WP3-5: Remove migrated content from Wiki (30h) ===		=== WP3-5: Remove migrated content from Wiki (30h) ===
Line 124:		Line 124:
	Eventually, we want to remove migrated content from the Wiki to prevent outdated information. At the same time, we will create a tighter integration between handbook web site and the Rodin Wiki. We'll also visit every single wiki page and if there is ambiguity on where the content should reside, we'll track down the owner and figure it out.		Eventually, we want to remove migrated content from the Wiki to prevent outdated information. At the same time, we will create a tighter integration between handbook web site and the Rodin Wiki. We'll also visit every single wiki page and if there is ambiguity on where the content should reside, we'll track down the owner and figure it out.

	'''Deliverable:''' Cleaned-up Wiki.		'''Deliverable:''' [http://wiki.event-b.org/ Cleaned-up Wiki].

	=== WP3-6: Iteration Review (20mh) ===		=== WP3-6: Iteration Review (20mh) ===

imported>Jastram: /* Third Iteration */

2011-10-09T19:18:05Z

Third Iteration

← Older revision		Revision as of 19:18, 9 October 2011
Line 120:		Line 120:
	'''Deliverable:''' Improved documentation, List of trouble spots.		'''Deliverable:''' Improved documentation, List of trouble spots.

	=== WP3-4: Remove migrated content from Wiki (30h) ===		=== WP3-5: Remove migrated content from Wiki (30h) ===

	Eventually, we want to remove migrated content from the Wiki to prevent outdated information. At the same time, we will create a tighter integration between handbook web site and the Rodin Wiki. We'll also visit every single wiki page and if there is ambiguity on where the content should reside, we'll track down the owner and figure it out.		Eventually, we want to remove migrated content from the Wiki to prevent outdated information. At the same time, we will create a tighter integration between handbook web site and the Rodin Wiki. We'll also visit every single wiki page and if there is ambiguity on where the content should reside, we'll track down the owner and figure it out.
Line 126:		Line 126:
	'''Deliverable:''' Cleaned-up Wiki.		'''Deliverable:''' Cleaned-up Wiki.

	=== WP3-5: Iteration Review (20mh) ===		=== WP3-6: Iteration Review (20mh) ===

	The last iteration will be used for “polishing” In this review, we allocate the resources as needed.		The last iteration will be used for “polishing” In this review, we allocate the resources as needed.

imported>Jastram: /* WP2-3: Guideline for Plugin Developers (20mh) */

2011-09-30T08:30:25Z

WP2-3: Guideline for Plugin Developers (20mh)

← Older revision		Revision as of 08:30, 30 September 2011
Line 88:		Line 88:
	Even though Plugins are officially not covered by the handbook, there are many places where covering some aspects would be extremely useful. We will produce a guideline for Plugin developers for including references to their work in the handbook.		Even though Plugins are officially not covered by the handbook, there are many places where covering some aspects would be extremely useful. We will produce a guideline for Plugin developers for including references to their work in the handbook.

	'''Deliverable:''' The Guideline.		'''Deliverable:''' [http://rodin-b-sharp.svn.sourceforge.net/viewvc/rodin-b-sharp/trunk/Handbook/org.rodinp.handbook.feature/latex/style-guide.tex?revision=13198&view=markup The Guideline].

	=== WP2-4: Iteration Review (20mh) ===		=== WP2-4: Iteration Review (20mh) ===

imported>Jastram: /* WP2-1: Migration and Creation of entries in the Reference Section (60mh) */

2011-09-30T08:28:13Z

WP2-1: Migration and Creation of entries in the Reference Section (60mh)

← Older revision		Revision as of 08:28, 30 September 2011
Line 76:		Line 76:
	We will start filling the reference section. We expect a number of sections to be quite labor-intensive, especially if it involves creating many screenshots.		We will start filling the reference section. We expect a number of sections to be quite labor-intensive, especially if it involves creating many screenshots.

	'''Deliverable:''' [[http://handbook.event-b.org/review-2/html/reference.html Completed Parts of the Reference Section]].		'''Deliverable:''' [http://handbook.event-b.org/review-2/html/reference.html Completed Parts of the Reference Section].

	=== WP2-2: Copy Editing of existing content (60mh) ===		=== WP2-2: Copy Editing of existing content (60mh) ===

imported>Jastram: /* WP2-2: Copy Editing of existing content (60mh) */

2011-09-30T08:28:00Z

WP2-2: Copy Editing of existing content (60mh)

← Older revision		Revision as of 08:28, 30 September 2011
Line 82:		Line 82:
	We managed to recruit Joy Clark, a native English speaking student, who will from this iteration on perform copy editing. In this iteration, she will make one complete run through the tutorial to improve copy and to identify gaps, which will then be filled.		We managed to recruit Joy Clark, a native English speaking student, who will from this iteration on perform copy editing. In this iteration, she will make one complete run through the tutorial to improve copy and to identify gaps, which will then be filled.

	'''Deliverable:''' Copy-edited content.		'''Deliverable:''' [http://handbook.event-b.org/review-2/html/ Copy-edited content].

	=== WP2-3: Guideline for Plugin Developers (20mh) ===		=== WP2-3: Guideline for Plugin Developers (20mh) ===

imported>Jastram: /* WP2-1: Migration and Creation of entries in the Reference Section (60mh) */

2011-09-30T08:27:04Z

WP2-1: Migration and Creation of entries in the Reference Section (60mh)

← Older revision		Revision as of 08:27, 30 September 2011
Line 76:		Line 76:
	We will start filling the reference section. We expect a number of sections to be quite labor-intensive, especially if it involves creating many screenshots.		We will start filling the reference section. We expect a number of sections to be quite labor-intensive, especially if it involves creating many screenshots.

	'''Deliverable:''' Completed Parts of the Reference Section.		'''Deliverable:''' [[http://handbook.event-b.org/review-2/html/reference.html Completed Parts of the Reference Section]].

	=== WP2-2: Copy Editing of existing content (60mh) ===		=== WP2-2: Copy Editing of existing content (60mh) ===

imported>Jastram: /* Third Iteration */

2011-09-28T18:40:03Z

Third Iteration

← Older revision		Revision as of 18:40, 28 September 2011
Line 96:		Line 96:
	== Third Iteration ==		== Third Iteration ==

	=== WP3-1: Completion of the Reference Section (~~40h~~) ===		=== WP3-1: Completion of the Reference Section (30h) ===

	The goal is to fill in all blanks in the reference section at this point. We may keep a list of entries that need improvements.		The goal is to fill in all blanks in the reference section at this point. We may keep a list of entries that need improvements.
Line 102:		Line 102:
	'''Deliverable:''' Complete Reference Section.		'''Deliverable:''' Complete Reference Section.

	=== WP3-2: User Tests of Tutorial (~~50mh~~) ===		=== WP3-2: User Tests of Tutorial (40mh) ===

	We will offer a B block course in fall 2011 in Düsseldorf, where the students will learn classical B (not Event-B). They will get a class project in Event-B. They will have to teach themselves Event-B using the tutorial, in order to solve their assignment. We will monitor the progress, collect feedback and identify overall weaknesses in the tutorial. We expect a group of 5-10 students.		We will offer a B block course in fall 2011 in Düsseldorf, where the students will learn classical B (not Event-B). They will get a class project in Event-B. They will have to teach themselves Event-B using the tutorial, in order to solve their assignment. We will monitor the progress, collect feedback and identify overall weaknesses in the tutorial. We expect a group of 5-10 students.

imported>Jastram: /* WP3-4: Remove migrated content from Wiki (10h) */

2011-09-28T18:39:36Z

WP3-4: Remove migrated content from Wiki (10h)

← Older revision		Revision as of 18:39, 28 September 2011
Line 120:		Line 120:
	'''Deliverable:''' Improved documentation, List of trouble spots.		'''Deliverable:''' Improved documentation, List of trouble spots.

	=== WP3-4: Remove migrated content from Wiki (~~10h~~) ===		=== WP3-4: Remove migrated content from Wiki (30h) ===

	Eventually, we want to remove migrated content from the Wiki to prevent outdated information. At the same time, we will create a tighter integration between handbook web site and the Rodin Wiki.		Eventually, we want to remove migrated content from the Wiki to prevent outdated information. At the same time, we will create a tighter integration between handbook web site and the Rodin Wiki. We'll also visit every single wiki page and if there is ambiguity on where the content should reside, we'll track down the owner and figure it out.

	'''Deliverable:''' ~~Complete Reference Section~~.		'''Deliverable:''' Cleaned-up Wiki.

	=== WP3-5: Iteration Review (20mh) ===		=== WP3-5: Iteration Review (20mh) ===