<sticky><div id="container" > <div id="header-title" style="padding: 10px 15px; border-width:1px; border-style:solid; border-color:#FFD28C; background-image: url(<nop>https://jazz.net/wiki/pub/Deployment/WebPreferences/TLASE.jpg); background-size: cover; font-size:120%"> ---+!! Deployment wiki roles and responsibilities %DKGRAY% Authors: Main.AmyLaird, Main.StevenBeard <br> Build basis: None %ENDCOLOR%</div></sticky> <!-- Page contents top of page on right hand side in box --> <sticky><div style="float:right; border-width:1px; border-style:solid; border-color:#DFDFDF; background-color:#F6F6F6; margin:0 0 15px 15px; padding: 0 15px 0 15px;"> %TOC{title="Page contents"}% </div></sticky> <sticky><div style="margin:15px;"></sticky> 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 [[DeploymentLeaders][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 [[DeploymentWikiVision][vision]] and strategy for the Deployment wiki * Building the Rational [[DeploymentWikiVision#DeploymentCommunity][Deployment community]] to support the wiki and other Rational client facing programs * Defining the wiki governance and management policies and guidelines, including: * [[DeploymentRolesAndResponsibilities][These roles and responsibilities]] * [[DeploymentWritingGuidelines][Writing guidelines]] * [[DeploymentExternalLinkingPolicy][External linking policy]] * [[DeploymentGuidanceOnMigratingArticles][Guidance on migrating articles]] * [[DeploymentFormattingGuidance][Formatting guidance]] * Reviewing and approving nominations for membership to the [[DeploymentTechnicalLeadersAndSeniorEditorsNominationForm][technical leaders and senior editors]], and [[DeploymentPractitionersNominationForm][deployment practitioners]] write access groups * Manage the [[https://jazz.net/jazz02/web/projects/Deployment%20Wiki#action=com.ibm.team.apt.viewPlan&page=com.ibm.team.apt.web.ui.plannedItems&id=_n26NRpDhEeKcd5Yt6Ydj9g&planMode=com.ibm.team.apt.viewmodes.internal.productBacklog.ranking][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 [[DeploymentLeaders][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 [[https://jazz.net/jazz02/web/projects/Deployment%20Wiki#action=com.ibm.team.dashboard.viewDashboard][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 [[https://jazz.net/jazz02/web/projects/Deployment%20Wiki#action=com.ibm.team.dashboard.viewDashboard&tab=_3"][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 [[DeploymentExternalLinkingPolicy][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 Main.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 [[DeploymentWikiVision][Deployment wiki vision]]. * Identify the appropriate [[WebHome][section of the wiki]] to which to add or modify the content. * For significant changes, please contact the [[DeploymentLeaders][section lead]] by email (their emails should be on their personal pages e.g. Main.StevenBeard) to discuss the proposed new or modified content. * Review the [[DeploymentWritingGuidelines][writing guidelines for the wiki]]. * Review the [[DeploymentFormattingGuidance][formatting guidance]] for the wiki. * Write the content in accordance with the established [[DeploymentWritingGuidelines][writing guidelines for the wiki]] * All topic pages only editable by technical leaders and senior editors (aka Main.TWikiDeploymentAuthorsGroup) MUST use the [[DeploymentFormattingGuidance#StatusIcons][status icon conventions]]. * Ensure that the content is technically accurate: * Through a work item in the [[https://jazz.net/jazz02/web/projects/Deployment%20Wiki#action=com.ibm.team.dashboard.viewDashboard][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 [[https://jazz.net/jazz02/web/projects/Deployment%20Wiki#action=com.ibm.team.dashboard.viewDashboard][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 [[DeploymentFormattingGuidance#StatusIcons][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 [[DeploymentExternalLinkingPolicy][linking guidelines for the wiki]]. ---++ Authors: Deployment practitioners (aka Main.TWikiAuthorsGroup and Main.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 [[DeploymentWikiVision][Deployment wiki vision]]. * Identify the appropriate [[WebHome][section of the wiki]] to which to add or modify the content. * For significant changes, please contact the [[DeploymentLeaders][section lead]] by email (their emails should be on their personal pages e.g. Main.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 [[DeploymentWritingGuidelines][writing guidelines for the wiki]]. * Review the [[DeploymentFormattingGuidance][formatting guidance]] for the wiki. * Draft the content for the wiki. * All topic pages editable by deployment practitioners (aka Main.TWikiAuthorsGroup and Main.TWikiExternalAuthorsGroup) SHOULD use the [[DeploymentFormattingGuidance#StatusIcons][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 [[DeploymentFormattingGuidance#StatusIcons][status icon conventions]]. ---++ User assistance writers These guidelines apply to the [[https://jazz.net/jazz02/web/projects/Deployment%20Wiki#action=com.ibm.team.dashboard.viewDashboard&tab=_3"][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 [[DeploymentWritingGuidelines][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 [[DeploymentExternalLinkingPolicy][linking guidelines for the wiki]]. ---++ User assistance editors These guidelines apply to the [[https://jazz.net/jazz02/web/projects/Deployment%20Wiki#action=com.ibm.team.dashboard.viewDashboard&tab=_3][IBM user assistance editors]] who are assigned to the wiki. * Establish and maintain the [[DeploymentWritingGuidelines][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 [[https://jazz.net/jazz02/web/projects/Deployment%20Wiki#action=com.ibm.team.dashboard.viewDashboard][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: * [[DeploymentRolesAndResponsibilities][These roles and responsibilities]] * [[DeploymentWritingGuidelines][Writing guidelines]] * [[DeploymentExternalLinkingPolicy][External linking policy]] * [[DeploymentGuidanceOnMigratingArticles][Guidance on migrating articles]] * [[DeploymentFormattingGuidance][Formatting guidance]] ---+++++!! External links: * [[https://jazz.net/jazz02/web/projects/Deployment%20Wiki#action=com.ibm.team.dashboard.viewDashboard][RTC project for the Deployment wiki]] ---+++++!! Additional contributors: Main.LauraHinson, Main.RalphEarle <sticky></div></div></sticky>
This topic: Deployment
>
WebHome
>
DeploymentRolesAndResponsibilities
History: r13 - 2013-05-03 - 13:12:08 - Main.sbeard
Copyright © by IBM and non-IBM contributing authors. All material on this collaboration platform is the property of the contributing authors.
Contributions are governed by our
Terms of Use.
Please read the following
disclaimer
.
Dashboards and work items are no longer publicly available, so some links may be invalid. We now provide similar information through other means. Learn more
here
.