Difference between revisions of "FTA:Development Methodology"

From Free Knowledge Free Technology Wiki
Jump to: navigation, search
(FTA Development Methodology)
(Development Cycle)
Line 12: Line 12:
 
== Development Cycle ==
 
== Development Cycle ==
  
# '''Scope phase'''
+
* '''Scope phase'''
 
** Decide on the contents of the ''project''
 
** Decide on the contents of the ''project''
 
** Decide on the ''roles'' within the project
 
** Decide on the ''roles'' within the project
# '''Early development phase'''  
+
* '''Early development phase'''  
 
** Sections to be managed using a standards based 'markdown' language like '''''[http://txt2tags.org/ txt2tags]'''''.
 
** Sections to be managed using a standards based 'markdown' language like '''''[http://txt2tags.org/ txt2tags]'''''.
 
***  Alternative options
 
***  Alternative options
Line 30: Line 30:
 
*** Time line
 
*** Time line
 
*** Development state, etc
 
*** Development state, etc
# '''Material assembly phase'''
+
* '''Material assembly phase'''
 
** Two parts to each course:
 
** Two parts to each course:
 
*** A Learner Guide.  
 
*** A Learner Guide.  
Line 37: Line 37:
 
*** Slideware
 
*** Slideware
 
*** Video lectures
 
*** Video lectures
# '''Beta release phase'''
+
* '''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.  
 
** 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..  
 
** Beta testers to review and log suggestions/errata etc..  
Line 45: Line 45:
 
** Tickets to be tracked and updates made as necessary with acknowledgements.  
 
** Tickets to be tracked and updates made as necessary with acknowledgements.  
 
** Review reported errara and omissions before moving to next phase.
 
** Review reported errara and omissions before moving to next phase.
# '''Final release phase'''
+
* '''Final release phase'''
 
** Apply an "official" FTA template
 
** Apply an "official" FTA template
 
*** Convert HTML manual to an '''Open Document Format (ODF)''' or whatever is decided.
 
*** 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.
 
**** 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)
 
*** Graphics to be standardised (specific volunteer help needed for this)

Revision as of 12:22, 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

  • 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 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
  • 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
  • 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.
  • 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)