379 lines
15 KiB
Plaintext
379 lines
15 KiB
Plaintext
head 1.10;
|
|
access;
|
|
symbols;
|
|
locks; strict;
|
|
comment @# @;
|
|
|
|
|
|
1.10
|
|
date 2006.12.18.13.06.15; author RogerHyam; state Exp;
|
|
branches;
|
|
next 1.9;
|
|
|
|
1.9
|
|
date 2006.09.25.18.57.42; author RicardoPereira; state Exp;
|
|
branches;
|
|
next 1.8;
|
|
|
|
1.8
|
|
date 2006.09.22.10.57.07; author RogerHyam; state Exp;
|
|
branches;
|
|
next 1.7;
|
|
|
|
1.7
|
|
date 2006.09.21.00.39.45; author LeeBelbin; state Exp;
|
|
branches;
|
|
next 1.6;
|
|
|
|
1.6
|
|
date 2006.09.20.17.04.30; author RogerHyam; state Exp;
|
|
branches;
|
|
next 1.5;
|
|
|
|
1.5
|
|
date 2006.09.20.12.27.42; author RogerHyam; state Exp;
|
|
branches;
|
|
next 1.4;
|
|
|
|
1.4
|
|
date 2006.09.20.08.43.45; author RogerHyam; state Exp;
|
|
branches;
|
|
next 1.3;
|
|
|
|
1.3
|
|
date 2006.09.18.15.23.02; author RogerHyam; state Exp;
|
|
branches;
|
|
next 1.2;
|
|
|
|
1.2
|
|
date 2006.09.11.23.51.42; author LeeBelbin; state Exp;
|
|
branches;
|
|
next 1.1;
|
|
|
|
1.1
|
|
date 2006.09.11.20.18.01; author RogerHyam; state Exp;
|
|
branches;
|
|
next ;
|
|
|
|
|
|
desc
|
|
@none
|
|
@
|
|
|
|
|
|
1.10
|
|
log
|
|
@none
|
|
@
|
|
text
|
|
@%META:TOPICINFO{author="RogerHyam" date="1166447175" format="1.1" version="1.10"}%
|
|
%META:TOPICPARENT{name="DocsDocumentation"}%
|
|
The final version of this report has now been submitted.
|
|
|
|
---+ Summary of Documentation Produced October 2005 to October 2006
|
|
|
|
|
|
---++ Introduction
|
|
This is a *summary* of the documentation work associated with the TDWG Infrastructure Project between October 2005 and October 2006. The document types were defined in the December 2005 a Documentation Strategy-
|
|
|
|
* *Type 1* documents are the normative parts of a standards. Examples of Type 1 documents are XML Schemas, human readable specifications that must be followed for compliance and controlled vocabularies. Type 1 documents are controlled by the TDWG standards process and are stable once ratified.
|
|
* *Type 2* documents are parts of the standard that are non-normative (informative). Examples of Type 2 documents include examples, code and illustrations that accompany and clarify the standard. As parts of a standard they are also controlled by the TDWG standards process and are stable but not normative. Normative documents have precedence over non-normative documents.
|
|
* *Type 3* documents are those that fall outside the standard. Examples of Type 3 documents are tutorials, guides, primers, wikis, discussion forums etc.
|
|
|
|
A “TDWG Standards Documentation Specification” is proposed as a new TDWG standard to govern TDWG standards (Type 1 and Type 2 documents). Templates and guides have been proposed for Type 3 documents.
|
|
|
|
* *Charters* All subgroups within TDWG must have a charter document that describes their mandate and core membership. The TDWG Online Environment provides a forms based application to develop charters.
|
|
* *Meeting Reports* All TDWG-related meetings must produce a summary document. A word template is provided to encourage effective, broad communication of outcomes.
|
|
* *Primers* All TDWG standards should be accompanied by an introductory document. This document should be understandable by those not involved in the development standard, and so encourage broad access to potential users.
|
|
|
|
The new TDWG website has a [[http://www.tdwg.gbif.org/subgroups/documentation/][page that describes the current documentation policy]].
|
|
|
|
Major documents produced during the year are listed below.
|
|
|
|
---++ What goes where?
|
|
|
|
A frequent concern of authors and subgroup conveners is where to put documentation. Under the new collaborative environment four main locations for documents and their functions are clearly defined.
|
|
1. *TDWG Wiki* This is the place for anything that is under development or likely to evolve through time. It can be used to collaboratively develop documents and for discussion. Any registered user can edit the wikis.
|
|
1. *Main TDWG Website* Each subgroup convener or their delegate has edit rights to their subgroup pages. Outputs of the subgroup (i.e. documents that have been finalised and will not changed) should be uploaded here. This is the 'public face' of the subgroup and is the point that users of standards and new group members will first see. It is therefore important that it presents a unified picture of the subgroups work.
|
|
1. *Standards Repository* Documents that form parts of formal standards (Types I and II) are stored in the standards repository. When a standard is proposed the documents are loaded into the repository where they are managed through the ratification process.
|
|
1. *rs.tdwg.org* This is a space for hosting documents that will be accessed at machine level. This area is not designed for human readable documentation other than that which forms part of such documents – XSD annotations and RDDL documents for example. Some documents that form part of a standard will be hosted both here and in the Standards Repository. Documents in the Standards Repository are normative. Experimental documents may also be hosted here during development of standards. Documents in the 'rs' domain may be polled frequently by machines and it is therefore important, for technical reasons, that the space is kept clear of large, rarely accessed documents. Write access to the 'rs' domain is via WebDAV and is controlled by the TDWG Online Environment administrator.
|
|
|
|
|
|
---++ Standards (Documents Types 1 and 2)
|
|
All standards, proposed standards and former standards are stored in the [[http://www.tdwg.gbif.org/standards/][standards repository]].
|
|
|
|
* [[http://wiki.tdwg.org/twiki/pub/Process/WebHome/TDWG_Process_2006-08-16.pdf][Process Document]] (this will be included in the repository after the St Louis meeting).
|
|
* [[http://www.tdwg.gbif.org/standards/id/85/][Standards Documentation Specification]]
|
|
* [[http://www.tdwg.gbif.org/standards/id/87/][LSID Applicability Statement]]
|
|
|
|
---++ Charters
|
|
Charters describe the remit and core members of subgroups. They are compiled using a form within the collaborative environment and form the home page for each subgroup on the TDWG website [[http://www.tdwg.gbif.org/subgroups/][subgroups section]]
|
|
|
|
* [[http://www.tdwg.gbif.org/subgroups/abcd/][ABCD]]
|
|
* [[http://www.tdwg.gbif.org/subgroups/ncd/][Natural Collections Descriptions Group]]
|
|
* [[http://www.tdwg.gbif.org/subgroups/sdd/][SDD]]
|
|
* [[http://www.tdwg.gbif.org/subgroups/process/][Process]]
|
|
* [[http://www.tdwg.gbif.org/subgroups/tag/][Technical Architecture Group]]
|
|
* [[http://www.tdwg.gbif.org/subgroups/guid/][Globally Unique Identifiers]]
|
|
* [[http://www.tdwg.gbif.org/subgroups/tcs/][Taxonomic Names and Concepts]]
|
|
* [[http://www.tdwg.gbif.org/subgroups/tapir/][TAPIR]]
|
|
* [[http://www.tdwg.gbif.org/subgroups/tip/][TDWG Infrastructure Group]]
|
|
* ISIS (Introduced Species Information System) *No Charter Entry Yet but we have a word doc. Does Nickie need Typo3 access?*
|
|
|
|
Missing to date
|
|
* [[http://www.tdwg.gbif.org/subgroups/economic-botany/][Economic Botany]]
|
|
* [[http://www.tdwg.gbif.org/subgroups/darwincore/][DarwinCore]]
|
|
* [[http://www.tdwg.gbif.org/subgroups/geography/][Geography]]
|
|
* [[http://www.tdwg.gbif.org/subgroups/gig/][Geospatial Interest Group]]
|
|
* [[http://www.tdwg.gbif.org/subgroups/img/][Imaging Group]]
|
|
* [[http://www.tdwg.gbif.org/subgroups/lit/][Literature Group]]
|
|
* [[http://www.tdwg.gbif.org/subgroups/obs/][Observational Group]]
|
|
|
|
|
|
---++ Primers (links?)
|
|
* SDD
|
|
* Taxon Concept
|
|
* ABCD
|
|
* TAPIR
|
|
|
|
---++ Meeting Reports
|
|
http://www.tdwg.gbif.org/subgroups/meeting-reports/
|
|
|
|
* [[http://www.tdwg.gbif.org/fileadmin/subgroups/meeting_reports/GUID1Report.pdf][GUID-1]]
|
|
* [[http://www.tdwg.gbif.org/fileadmin/subgroups/meeting_reports/GUID2Report.pdf][GUID-2]]
|
|
* [[http://www.tdwg.gbif.org/fileadmin/subgroups/meeting_reports/TAG-1_Report_Final.pdf][TAG-1]]
|
|
* [[http://www.tdwg.gbif.org/fileadmin/subgroups/meeting_reports/SDD_2006_BerlinSummary.pdf][ABCD]]
|
|
* Geospatial - written enquiring about
|
|
* TAPIR - written enquiring about
|
|
* NCD - written enquiring about..
|
|
|
|
---++ Non-Standards Specifications
|
|
* TAPIR Spec from Charles - will link to from report. Standardisation process will begin after St Louis meeting.
|
|
|
|
---++ TDWG Infrastructure Project
|
|
The TIP has produce 18 official documents over the past year. All the documents are available in the [[http://www.tdwg.gbif.org/subgroups/tip/tip-document-archive/][TIP Document Archive]]. Key documents include:
|
|
* [[http://www.tdwg.gbif.org/fileadmin/subgroups/tip/GMBF_Project_Milestones.xls][TDWG Infrastructure Project Milestones]] - a summary of the milestones for the TIP.
|
|
* [[http://www.tdwg.gbif.org/fileadmin/subgroups/tag/TAG_Roadmap.doc][TAG Roadmap 2006]] - A summary of a technical architecture for TDWG and plan for its adoption.
|
|
* [[http://www.tdwg.gbif.org/standards/id/85/tdwg_standards_documentation_specification.html][Documentation Specification for TDWG Standards]] - A specification for new TDWG Standards.
|
|
* [[http://www.tdwg.gbif.org/fileadmin/subgroups/tip/TDWG_Website_Requirements.doc][Requirements for the New TDWG Website]]
|
|
|
|
[Lee - which are your key documents]
|
|
|
|
---+++ GUID Documents (Lee: maybe worth cross-referencing things like roadmaps, applicability statements?)
|
|
* http://www.tdwg.gbif.org/subgroups/guid/documents-reports/
|
|
|
|
-- Main.RogerHyam - 11 Sep 2006@
|
|
|
|
|
|
1.9
|
|
log
|
|
@none
|
|
@
|
|
text
|
|
@d1 1
|
|
a1 1
|
|
%META:TOPICINFO{author="RicardoPereira" date="1159210662" format="1.1" version="1.9"}%
|
|
d3 2
|
|
d97 1
|
|
a97 1
|
|
-- Main.RogerHyam - 11 Sep 2006
|
|
@
|
|
|
|
|
|
1.8
|
|
log
|
|
@none
|
|
@
|
|
text
|
|
@d1 1
|
|
a1 1
|
|
%META:TOPICINFO{author="RogerHyam" date="1158922627" format="1.1" version="1.8"}%
|
|
d88 3
|
|
a90 2
|
|
* Website Requirements
|
|
[Lee/Ricardo - which are your key documents]
|
|
@
|
|
|
|
|
|
1.7
|
|
log
|
|
@none
|
|
@
|
|
text
|
|
@d1 1
|
|
a1 1
|
|
%META:TOPICINFO{author="LeeBelbin" date="1158799185" format="1.1" version="1.7"}%
|
|
d35 1
|
|
a35 1
|
|
* Process Document - NOT TILL OCTOBER.
|
|
d76 3
|
|
a78 3
|
|
* Geospatial
|
|
* TAPIR
|
|
* NCD
|
|
d81 1
|
|
a81 1
|
|
* TAPIR Spec from Charles - should this be XHTMLised? (Lee: Yes)
|
|
d83 7
|
|
a89 2
|
|
---++ TDWG Infrastructure Specific (with links)
|
|
* ... from deliverables page
|
|
d94 1
|
|
a94 1
|
|
-- Main.RogerHyam - 11 Sep 2006@
|
|
|
|
|
|
1.6
|
|
log
|
|
@none
|
|
@
|
|
text
|
|
@d1 1
|
|
a1 1
|
|
%META:TOPICINFO{author="RogerHyam" date="1158771870" format="1.1" version="1.6"}%
|
|
d7 1
|
|
a7 1
|
|
This document is a summary of the TDWG documentation efforts between October 2005 and October 2006. During this period the TDWG Infrastructure Project has been developing a new collaborative infrastructure for the organisation.
|
|
d9 2
|
|
a10 4
|
|
In December 2005 a Documentation Strategy was proposed. It is based on three kinds of document.
|
|
|
|
* *Type 1* documents are the normative parts of a standards. Examples of Type 1 documents are XML Schemas, human readable specifications that must be followed for compliance and controlled vocabularies. Type 1 documents are controlled by the TDWG standards process and are highly stable once ratified.
|
|
* *Type 2* documents are parts of the standard that are non-normative (informative). Examples of Type 2 documents include examples, code and illustrations that accompany and clarify the standard. As parts of a standard they are also controlled by the TDWG standards process and are highly stable but not normative. The normative documents have precedence over them.
|
|
d13 1
|
|
a13 1
|
|
A “TDWG Standards Documentation Specification” has been developed and is proposed as a new TDWG standard to govern TDWG standards (Type 1 and Type 2 documents) going forward. Less formal templates and documentation approaches have been suggested for Type 3 documents.
|
|
d15 3
|
|
a17 3
|
|
* *Charters* All subgroups within TDWG must have a charter document that describes their remit and core membership. The collaboration environment provides a forms based application to develop charters.
|
|
* *Meeting Reports* It is suggested that all TDWG meetings should produce a summary document for general consumption. A word template is provided for this.
|
|
* *Primers* It is suggested that all TDWG standards be accompanied by an introductory document. This document should be understandable by those not involved in the development standard itself and so provide access to the standard for potential users.
|
|
d25 1
|
|
a25 1
|
|
A frequent concern of authors and subgroup conveners is where to put documentation. Under the new collaborative environment four main locations for documents and their functions are clearly demarked.
|
|
d27 3
|
|
a29 3
|
|
1. *Main TDWG Website* Each subgroup convener has edit rights to the part of the main TDWG website that deals with their subgroup. Outputs of the subgroup (i.e. documents that have been finalised and will not changed) should be uploaded here. This is the 'public face' of the subgroup and is the point that users of standards and new group members will first see. It is therefore important that it presents a unified picture of the subgroups work.
|
|
1. *Standards Repository* Documents that form parts of formal standards (Types I and II) are stored in the standards repository. When a standard is proposed the documents are loaded into the repository where they are managed through the process of becoming ratified.
|
|
1. *rs.tdwg.org* This is a space for hosting documents that will be accessed by machines. It is principally not for human readable documentation other than that which forms part of such documents – XSD annotations and RDDL documents for example. Some documents that form parts of a standards will be hosted both here and in the Standards Repository. The ones in the Standards Repository are normative. Experimental documents may also be hosted here during development of standards. Documents in the 'rs' domain may be polled frequently by machines and it is therefore important, for technical reasons, that the space is kept clear of large, rarely accessed documents. Write access to the 'rs' domain is via WebDAV and is controlled by the TDWG environment administrator.
|
|
d53 1
|
|
a53 1
|
|
Missing
|
|
d63 1
|
|
a63 1
|
|
---++ Primers
|
|
d83 1
|
|
a83 1
|
|
---++ TDWG Infrastructure Specific
|
|
d86 1
|
|
a86 1
|
|
---+++ GUID Documents
|
|
d89 1
|
|
a89 1
|
|
-- Main.RogerHyam - 11 Sep 2006
|
|
@
|
|
|
|
|
|
1.5
|
|
log
|
|
@none
|
|
@
|
|
text
|
|
@d1 1
|
|
a1 1
|
|
%META:TOPICINFO{author="RogerHyam" date="1158755262" format="1.1" version="1.5"}%
|
|
d21 2
|
|
d35 5
|
|
a39 3
|
|
* Process Document
|
|
* Standards Documentation Specification
|
|
* LSID Applicability Statement
|
|
d42 22
|
|
a63 7
|
|
* ABCD
|
|
* SDD
|
|
* Process
|
|
* TAG
|
|
* Taxon Names and Concepts
|
|
* Economic Botany
|
|
* ISIS (Introduced Species Information System)
|
|
d74 4
|
|
a77 4
|
|
* GUID-1
|
|
* GUID-2
|
|
* TAG-1
|
|
* ABCD (http://www.tdwg.gbif.org/fileadmin/subgroups/meeting_reports/SDD_2006_BerlinSummary.pdf)
|
|
d89 1
|
|
a89 1
|
|
* http://www.tdwg.gbif.org/subgroups/guid/documents-reports/
|
|
@
|
|
|
|
|
|
1.4
|
|
log
|
|
@none
|
|
@
|
|
text
|
|
@d1 1
|
|
a1 1
|
|
%META:TOPICINFO{author="RogerHyam" date="1158741825" format="1.1" version="1.4"}%
|
|
d7 1
|
|
d9 13
|
|
d26 4
|
|
a29 4
|
|
1. *TDWG Wiki* This is the place for anything that is under development or likely to evolve through time. It can be used to collaboratively develop documents
|
|
1. *Main TDWG Website*
|
|
1. *Standards Repository*
|
|
1. *rs.tdwg.org*
|
|
d53 2
|
|
d58 1
|
|
a58 1
|
|
* ABCD
|
|
d68 1
|
|
@
|
|
|
|
|
|
1.3
|
|
log
|
|
@none
|
|
@
|
|
text
|
|
@d1 1
|
|
a1 1
|
|
%META:TOPICINFO{author="RogerHyam" date="1158592982" format="1.1" version="1.3"}%
|
|
d6 12
|
|
d55 1
|
|
a55 1
|
|
-- Main.RogerHyam - 11 Sep 2006@
|
|
|
|
|
|
1.2
|
|
log
|
|
@none
|
|
@
|
|
text
|
|
@d1 1
|
|
a1 1
|
|
%META:TOPICINFO{author="LeeBelbin" date="1158018702" format="1.1" version="1.2"}%
|
|
d40 2
|
|
d43 1
|
|
a43 1
|
|
-- Main.RogerHyam - 11 Sep 2006
|
|
@
|
|
|
|
|
|
1.1
|
|
log
|
|
@none
|
|
@
|
|
text
|
|
@d1 1
|
|
a1 1
|
|
%META:TOPICINFO{author="RogerHyam" date="1158005881" format="1.1" version="1.1"}%
|
|
d18 1
|
|
d32 2
|
|
d36 1
|
|
a36 1
|
|
* TAPIR Spec from Charles - should this be XHTMLised?
|
|
@
|