Fw: Revised charter for the proposed DITA for Programmer Content Subcommittee [for vote]

resending

----- Forwarded by Lisa Dyer/Austin/IBM on 09/20/2011 10:18 AM -----

From:

Lisa Dyer/Austin/IBM

To:



Date:

09/20/2011 10:12 AM

Subject:

Revised charter for the proposed DITA for Programmer Content Subcommittee [for vote]

revisions in blue

Charter for DITA for Programmer Content Subcommittee

 

Goals

 

1.       Provide an open forum for discussion about the use of DITA content to create programming reference information in outputs including HTML, PDF, and embedded assistance.

2.       Provide standard DITA XML specializations for delivering programming reference information, with special consideration given to:

·         requirements for embedded assistance and progressive disclosure (for example, when a product provides a programming or script editor) 

·         the use of commonly adopted information designs for programming reference information

·         coalescing any existing standardization work across the industry

·         project requirements, design, and test case items, with the ability to provide linkage and automatic traceability verification

 

Deliverables

 

1.       Specifications for producing reference information in DITA XML for the commonly used programming languages:
1.       Java

2.       _javascript_

3.       C++
2.       Specifications for authoring project documentation in DITA XML which can produce software project artifacts, such as:
1.       Project Information

2.       Requirements

3.       Design

4.       Test Plan

with an automatically generated Requirements Traceability Verfication Matrix
3.       Detailed documentation about how to make use of the specializations. 

4.       A sample implementation of each specialization.

 

The subcommittee will consider additional deliverables as stretch goals depending on participation.

Lisa J Dyer

Community manager

Samples development

IBM BPM and WebSphere Lombardi Edition

IBM Software Group, AIM

512..970.4147