Difference between revisions of "FTA:Development Methodology"

From Free Knowledge Free Technology Wiki
Jump to: navigation, search
(FTA Development Methodology)
Line 1: Line 1:
−
'''FTA Development Methodology'''
+
= FTA Development Methodology =
  
 
The original FTA manuals look fantastic and I believe the work was funded heavily by the EU. The problem as I see it is the tenancy to obsolete quite fast.
 
The original FTA manuals look fantastic and I believe the work was funded heavily by the EU. The problem as I see it is the tenancy to obsolete quite fast.
Line 10: Line 10:
 
** '''translator'''  
 
** '''translator'''  
  
−
* The initial development phase using a standards based 'markdown' language like '''''txt2tags'''''.
+
== Development Cycle ==
 +
 
 +
# '''Scope phase'''
 +
** Decide on the contents of the ''project''
 +
** Decide on the ''roles'' within the project
 +
# '''Early development phase'''
 +
** Sections to be managed using a standards based 'markdown' language like '''''[http://txt2tags.org/ txt2tags]'''''.
 +
***  Alternative options
 +
**** booki
 +
**** [http://cnx.org CNX/OpenStax] (has its own XML standard (CNMXL, but also allows MathML and other XML standards to be im/exported from their online platform).
 +
'''Note 1:''' Training will be needed when this is defined.
 +
'''Note 2: (WT): Access Control: how do we handle permissions of users with different roles and projects?
 +
** Wiki template for the course development page
 +
*** State the course title, objectives
 +
*** Pre-requirements
 +
*** Who's involved
 +
*** Tasks to be done
 +
**** It being part of certain curriculums or course programmes
 +
*** Time line
 +
*** Development state, etc
 +
# '''Material assembly phase'''
 
** Two parts to each course:
 
** Two parts to each course:
 
*** A Learner Guide.  
 
*** A Learner Guide.  
Line 17: Line 37:
 
*** Slideware
 
*** Slideware
 
*** Video lectures
 
*** Video lectures
−
 
+
# '''Beta release phase'''
−
* Bi-annually the '''''txt2tags''''' are put together as 'html' published '''Beta''' material that is accessible by those that sign on for such materials. Such Beta testers to review and log suggestions/errata etc..  
+
** Bi-annually the '''''txt2tags''''' are assembled as 'html' published '''Beta''' material that is accessible by those that sign on for such materials.  
−
  * Perhaps a ticketing system like [https://www.bestpractical.com/rt/ RT: Request Tracker] could be used for this purpose.
+
** Beta testers to review and log suggestions/errata etc..  
−
    -> WT: it's under GPLv2 so that's fine, and its features seem interesting. Who can set it up on our server?
+
** Ticketing system:
−
    -> WT: I'm happy to test it out. Other alternatives would be to have a task plugin within MediaWiki, which would help to keep it simpler for the users (one system).
+
*** [https://www.bestpractical.com/rt/ RT: Request Tracker] (GPLv2) could be used for this purpose.
−
    -> OB: MediaWiki is fine by me also, the point is more about the process than the technology for tracking.
+
*** [http://www.mediawiki.org/wiki/Extension:Tasks MediaWiki Extension:Tasks]
−
  * Tickets to be tracked and updates made as necessary with acknowledgements.  
+
** Tickets to be tracked and updates made as necessary with acknowledgements.  
−
* Following the '''Beta''' process the HTML manual is converted to an '''Open Document Format (ODF)''' or whatever is decided.
+
** Review reported errara and omissions before moving to next phase.
−
  * Stages
+
# '''Final release phase'''
−
    - Graphics to be standardised (specific volunteer help needed for this) (WT: I'd say that in the development cycle, we apply an "official" FTA template only when it has passed a certain review phase, so it'll help identify quality tested materials.)
+
** Apply an "official" FTA template
−
    - A method to convert the markdown or HTML to the ODF and '''Portable Document Format (PDF)''' formats. And ebook formats like ePub.
+
*** Convert HTML manual to an '''Open Document Format (ODF)''' or whatever is decided.
−
 
+
**** A method to convert the markdown or HTML to the ODF and '''Portable Document Format (PDF)''' formats. And ebook formats like ePub.
−
I would really be interested if this is of interest to the membership ? What do you think ?
+
*** Graphics to be standardised (specific volunteer help needed for this)
−
 
+
−
--[[User:Diarmuid|An Laoch]] ([[User talk:Diarmuid|talk]]) 10:23, 30 September 2014 (CEST)
+
−
 
+
−
Thanks Diarmuid for opening this discussion - a very important one! Here are a few more thoughts --[[User:Wouter|Wouter]] ([[User talk:Wouter|talk]]) 10:50, 2 October 2014 (CEST):
+
−
* '''formats''': since 2008 the FTA has been debating about the ideal development cycle and the appropriate open standard formats to be used. We agreed years ago that SCORM and DocBook were the desirable formats, in particular DocBook, because it is a very granular XML standard that has basically all neded for professional DTP processes to produce the desired books universities want, while at the same time it can be dealt with in LaTeX and from there to all other formats. But we haven't found a good way to do online collaborative authoring in DocBook, so at the end it didn't work well. So the suggestion of txt2tags seems a very reasonable one. Otherwise we'll have booki, or CNX/OpenStax (has its own XML standard (CNMXL, but also allows MathML and other XML standards to be im/exported from their online platform). At this point I agree that we should just start setting up a [[http://txt2tags.org/ txt2tags]] server and start using it. BTW I can't see any Access Control feature at first sight, how do we handle permissions of users with different roles and projects?
+
−
* We should develop a wiki template for the course development page, where we can state the course title, objectives, prerequirements, who's involved, tasks to be done, it being part of certain curriculums or course programmes, time line, development state, etc
+

Revision as of 12:21, 2 October 2014

FTA Development Methodology

The original FTA manuals look fantastic and I believe the work was funded heavily by the EU. The problem as I see it is the tenancy to obsolete quite fast.

To get things started I propose that the FTA create a development manual with a number of stages.

  • Each project should have roles like:
    • contributor
    • reviewer
    • translator

Development Cycle

  1. Scope phase
    • Decide on the contents of the project
    • Decide on the roles within the project
  1. Early development phase
    • Sections to be managed using a standards based 'markdown' language like txt2tags.
      • Alternative options
        • booki
        • CNX/OpenStax (has its own XML standard (CNMXL, but also allows MathML and other XML standards to be im/exported from their online platform).

Note 1: Training will be needed when this is defined. Note 2: (WT): Access Control: how do we handle permissions of users with different roles and projects?

    • Wiki template for the course development page
      • State the course title, objectives
      • Pre-requirements
      • Who's involved
      • Tasks to be done
        • It being part of certain curriculums or course programmes
      • Time line
      • Development state, etc
  1. Material assembly phase
    • Two parts to each course:
      • A Learner Guide.
      • A Learner Workbook. [IMS QTI]] for compatibility with Moodle)
    • Optional parts, depending on the educational methodology:
      • Slideware
      • Video lectures
  1. Beta release phase
    • Bi-annually the txt2tags are assembled as 'html' published Beta material that is accessible by those that sign on for such materials.
    • Beta testers to review and log suggestions/errata etc..
    • Ticketing system:
    • Tickets to be tracked and updates made as necessary with acknowledgements.
    • Review reported errara and omissions before moving to next phase.
  1. Final release phase
    • Apply an "official" FTA template
      • Convert HTML manual to an Open Document Format (ODF) or whatever is decided.
        • A method to convert the markdown or HTML to the ODF and Portable Document Format (PDF) formats. And ebook formats like ePub.
      • Graphics to be standardised (specific volunteer help needed for this)
Retrieved from "http://wiki.freeknowledge.eu/index.php?title=FTA:Development_Methodology&oldid=46"