Difference between revisions of "FTA:Development Methodology"

From Free Knowledge Free Technology Wiki
Jump to: navigation, search
(FTA Development Methodology)
 
(12 intermediate revisions by 2 users 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 5: Line 7:
 
To get things started I propose that the FTA create a development manual with a number of stages.
 
To get things started I propose that the FTA create a development manual with a number of stages.
  
* Each project should have a controlling '''editor''' that is responsible for releases.
+
* Each project should have roles like:
* The initial development phase using a standards based 'markdown' language like '''''txt2tags'''''.
+
** '''contributor'''
  * Two parts to each course:
+
** '''reviewer'''
    - A Student Guide.
+
** '''translator'''  
    - A separate Course Exercise Workbook.
+
 
    - Slideware ?
+
== Development Cycle ==
* 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..  
+
 
  * Perhaps a ticketing system like [https://www.bestpractical.com/rt/ RT: Request Tracker] could be used for this purpose.
+
=== '''Scope phase''' ===
  * Tickets to be tracked and updates made as necessary with acknowledgemets.
+
* Decide on the contents of the ''project''
* Following the 'Beta' process the HTML manual is converted to an '''Open Document Format (ODF)''' or whatever is decided.
+
* Decide on the ''roles'' within the project
  * Stages
+
 
    - Graphics to be standardised (specific volunteer help needed for this)
+
=== '''Early development phase''' ===
    - A method to convert the markdown or HTML to the ODF and '''Portable Document Format (PDF)''' formats.
+
* 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
  
I would really be interested if this is of interest to the membership ? What do you think ?
+
=== '''Material assembly phase''' ===
 +
* Two parts to each course:
 +
** A Learner Guide.
 +
** A Learner Workbook. [[http://en.wikipedia.org/wiki/QTI IMS QTI]]] for compatibility with Moodle)
 +
* Optional parts, depending on the educational methodology:
 +
** Slideware
 +
** Video lectures
  
--[[User:Diarmuid|An Laoch]] ([[User talk:Diarmuid|talk]]) 10:23, 30 September 2014 (CEST)
+
=== '''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:
 +
** [https://www.bestpractical.com/rt/ RT: Request Tracker] (GPLv2) could be used for this purpose.
 +
** [http://www.mediawiki.org/wiki/Extension:Tasks MediaWiki Extension:Tasks]  
 +
* 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)

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)