Difference between revisions of "FTA:Development Methodology"

From Free Knowledge Free Technology Wiki
Jump to: navigation, search
(Development Cycle)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
= FTA Development Methodology =
+
__TOC__
 +
 
 +
= Introduction =
  
 
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 12: Line 14:
 
== 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'''  
+
 
** Sections to be managed using a standards based 'markdown' language like '''''[http://txt2tags.org/ txt2tags]'''''.
+
=== '''Early development phase''' ===
***  Alternative options
+
* Sections to be managed using a standards based 'markdown' language like '''''[http://txt2tags.org/ txt2tags]'''''.
**** booki
+
**  Alternative options
**** [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).  
+
*** booki
***'''Note 1:''' Training will be needed when this is defined.
+
*** [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 2: (WT): Access Control: how do we handle permissions of users with different roles and projects?
+
****'''Note 1:''' Training will be needed when this is defined.
** Wiki template for the course development page
+
****'''Note 2:''' (WT): Access Control: how do we handle permissions of users with different roles and projects?
*** State the course title, objectives
+
* Wiki template for the course development page
*** Pre-requirements
+
** State the course title, objectives
*** Who's involved
+
** Pre-requirements
*** Tasks to be done
+
** Who's involved
**** It being part of certain curriculums or course programmes
+
** Tasks to be done
*** Time line
+
*** It being part of certain curriculums or course programmes
*** Development state, etc
+
** Time line
* '''Material assembly phase'''
+
** Development state, etc
** Two parts to each course:
+
 
*** A Learner Guide.  
+
=== '''Material assembly phase''' ===
*** A Learner Workbook. [[http://en.wikipedia.org/wiki/QTI IMS QTI]]] for compatibility with Moodle)
+
* Two parts to each course:
** Optional parts, depending on the educational methodology:
+
** A Learner Guide.  
*** Slideware
+
** A Learner Workbook. [[http://en.wikipedia.org/wiki/QTI IMS QTI]]] for compatibility with Moodle)
*** Video lectures
+
* Optional parts, depending on the educational methodology:
* '''Beta release phase'''
+
** Slideware
** Bi-annually the '''''txt2tags''''' are assembled as 'html' published '''Beta''' material that is accessible by those that sign on for such materials.  
+
** Video lectures
** Beta testers to review and log suggestions/errata etc..  
+
 
** Ticketing system:
+
=== '''Beta release phase''' ===
*** [https://www.bestpractical.com/rt/ RT: Request Tracker] (GPLv2) could be used for this purpose.
+
* Bi-annually the '''''txt2tags''''' are assembled as 'html' published '''Beta''' material that is accessible by those that sign on for such materials.  
*** [http://www.mediawiki.org/wiki/Extension:Tasks MediaWiki Extension:Tasks]  
+
* Beta testers to review and log suggestions/errata etc..  
** Tickets to be tracked and updates made as necessary with acknowledgements.  
+
* Ticketing system:
** Review reported errara and omissions before moving to next phase.
+
** [https://www.bestpractical.com/rt/ RT: Request Tracker] (GPLv2) could be used for this purpose.
* '''Final release phase'''
+
** [http://www.mediawiki.org/wiki/Extension:Tasks MediaWiki Extension:Tasks]  
** Apply an "official" FTA template
+
* Tickets to be tracked and updates made as necessary with acknowledgements.  
*** Convert HTML manual to an '''Open Document Format (ODF)''' or whatever is decided.
+
* Review reported errara and omissions before moving to next phase.
**** A method to convert the markdown or HTML to the ODF and '''Portable Document Format (PDF)''' formats. And ebook formats like ePub.
+
=== '''Final release phase''' ===
*** Graphics to be standardised (specific volunteer help needed for this)
+
* 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)

Latest revision as of 12:28, 2 October 2014

Introduction

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)