Deployment wiki roles and responsibilities

The following responsibilities clarify roles for the wiki and ensure that content is reviewed for technical accuracy, adherence to writing guidelines, and the correct location for the information.

Community technical leaders and senior editors

The community technical leaders and senior editors will govern and manage the overall wiki. This leadership team will be comprised of deployment leaders, experts and senior editors, including all section leads, from IBM and a few customers and partners. This team will be responsible for:

• Setting the overall vision and strategy for the Deployment wiki
• Building the Rational Deployment community to support the wiki and other Rational client facing programs
• Defining the wiki governance and management policies and guidelines, including:
  • These roles and responsibilities
  • Writing guidelines
  • External linking policy
  • Guidance on migrating articles
  • Formatting guidance
• Reviewing and approving nominations for membership to the technical leaders and senior editors, and deployment practitioners write access groups
• Manage the backlog of proposals for new content for the wiki
• Maintain the overall consistency and quality of the content of the wiki, in particular between sections.

Section leads

These guidelines apply to the designated section leads for the wiki:

• Coordinate the team, strategy, structure and population for their assigned wiki section
  • Identify existing content to move and new content to add to their wiki section
  • Identify authors to add the content to the wiki and assign work by using the RTC project for the Deployment wiki
  • Inform authors of their roles and responsibilities, and the policies and guidelines for the wiki.

• Monitor the content of their wiki section
  • Monitor the incoming content to the section
  • Ensure that content is current and accurate
  • Ensure that content is receiving the appropriate technical reviews
  • Address incorrect, outdated, or inappropriate content as a matter of urgency.

• Coordinate with the user assistance representative for the section
  • Ensure that the user assistance representative is aware of incoming content
  • Ensure that the user assistance representative is receiving review requests for the content
  • Coordinate with the user assistance representative to verify whether content belongs in an information center or other product documentation or the wiki
  • Verify that links are established between the information centers and wiki in accordance with the established linking guidelines for the wiki.

• Maintain the content of their wiki section
  • Each release, review the content to ensure that it is still relevant and up to date and update the topic page's build basis as appropriate.

Authors: Technical leaders and senior editors (aka TWikiDeploymentAuthorsGroup)

These guidelines apply to authors who are identified technical leaders and senior editors:

• Identify the content to be potentially added or modified within the wiki.
  • Verify that the content does not already exist in another location, such as in the information center, on Jazz.net, or on developerWorks.
  • Verify that the content meets the criteria for the wiki as described in the Deployment wiki vision.

• Identify the appropriate section of the wiki to which to add or modify the content.
  • For significant changes, please contact the section lead by email (their emails should be on their personal pages e.g. StevenBeard) to discuss the proposed new or modified content.

• Review the writing guidelines for the wiki.
• Review the formatting guidance for the wiki.
• Write the content in accordance with the established writing guidelines for the wiki
  • All topic pages only editable by technical leaders and senior editors (aka TWikiDeploymentAuthorsGroup) MUST use the status icon conventions.

• Ensure that the content is technically accurate:
  • Through a work item in the RTC project for the Deployment wiki, use the Approvals tab to obtain a technical review from a minimum of two people: a subject-matter expert (SME) for the subject, and the content lead for the wiki section.

• Obtain a user assistance review for all content:
  • Through a work item in the RTC project for the Deployment wiki, inform the user assistance (UA) contact for the wiki area that content is available and use the Approvals tab to request a UA review.
  • After technical and UA reviews, change or remove the under construction icon to denote its new status in accordance with the status icon conventions.

• Maintain the wiki content:
  • For each new release, ensure that the content remains current; apply updates as needed.
  • Review and maintain links between the wiki and the information center (IC) for each release, in accordance with the established linking guidelines for the wiki.

Authors: Deployment practitioners (aka TWikiAuthorsGroup and TWikiExternalAuthorsGroup) and Jazz.net uses

These guidelines apply to contributors from the broader community.

• Identify the content to be potentially added or modified within the wiki.
  • Verify that the content does not already exist in another location, such as in the information center, on Jazz.net, or on developerWorks.
  • Verify that the content meets the criteria for the wiki as described in the Deployment wiki vision.

• Identify the appropriate section of the wiki to which to add or modify the content.
  • For significant changes, please contact the section lead by email (their emails should be on their personal pages e.g. StevenBeard) to discuss the proposed new or modified content.
  • You may need the help of the section lead to initially create a new topic page and set the appropriate level of write access.

• Review the writing guidelines for the wiki.
• Review the formatting guidance for the wiki.
• Draft the content for the wiki.
  • All topic pages editable by deployment practitioners (aka TWikiAuthorsGroup and TWikiExternalAuthorsGroup) SHOULD use the status icon conventions.

• If possible, obtain a technical review from subject matter experts.
• After technical review, change or remove the under construction icon to denote its new status in accordance with the status icon conventions.

User assistance writers

These guidelines apply to the IBM user assistance writers who are assigned to sections of the wiki.

• Periodically review all content in the assigned wiki section
• Copy edit the content in the assigned area based on the established writing guidelines for the wiki
• As time permits, further improve the content quality by applying writing, style, and word usage guidelines
• Investigate and determine where content belongs (in the wiki or an IC) and coordinate any movement of information:
• Review and maintain links between the wiki and the ICs for each release, in accordance with the established linking guidelines for the wiki.

User assistance editors

These guidelines apply to the IBM user assistance editors who are assigned to the wiki.

• Establish and maintain the writing guidelines for the wiki
• Consult when authors have content, structure, or style questions
• Periodically review the wiki content for adherence to the established writing guidelines, ideally toward the end of each release, individual release timing TBD
  • Coordinate the user assistance review of the wiki by using the RTC project for the Deployment wiki
• As time permits, make ad hoc edits to content based on the established writing guidelines for the wiki.

Related topics:

• These roles and responsibilities
• Writing guidelines
• External linking policy
• Guidance on migrating articles
• Formatting guidance

External links:

• RTC project for the Deployment wiki

Additional contributors: LauraHinson, RalphEarle