Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Describe the structure of the group responsible for CAS software documentation.

Draft Version

The following draft policy document is a work in progress.

Responsibilities

The CAS Documentation Stewardship Group is responsible for all aspects of CAS server and client software including the following:

  • Developing and maintaining an organizational strategy for documentation that is clear, complete, and manageable.
  • Developing content standards and facilitating compliance with standards.
  • Collaborating with developers and user base to provide complete and current documentation for common configuration and deployment scenarios.
  • Collaborating with developers to provide development documentation such as protocol specifications, high-level software APIs, and core software components to facilitate integration and customization.
  • Ensuring that version-specific documentation is current and clearly indicated.
  • Performing regular content review to ensure completeness, accuracy, currency, and conformity with standards and organizational strategy.

Stewardship Group Roles

Documentation Coordinator

The Documentation Coordinator (DC) is the quality control person who takes the lead on organization strategy, content standards, and content quality (accuracy, currency, completeness). The DC is not directly responsible for content (although if technically skilled, he or she could certainly contribute directly), but instead reviews existing and candidate documentation for quality, conformity to standards, and determines how to integrate contributions into the organizational system. The DC is expected to collaborate with other group members in the development of organizational strategies and standards.

Developer Liaison

The Developer Liaison (DL) is responsible for assisting the DC with technical matters related to documentation. The DL performs technical content reviews, or is responsible for delegating content reviews to other developers as needed, at the request of the DC. The DL is also responsible for producing or delegating the production of development documentation that is deemed necessary by the DC.

Documentation Steward

The Documentation Stewardship Group may have numerous Documentation Stewards (DS) to which the DC may delegate his duties for a smaller content domain. For example, the phpCAS lead developer may volunteer as DS of the phpCAS documentation section, taking direct responsibility for organization and content standards for documentation in that area. Documentation Stewards should work closely with the DC, taking care to following global organizational and content standards developed by the DC for the entire body of documentation.

  • No labels