Are there guidelines for involving subject matter experts (SMEs) and engineers in DITA-based telecom content reviews?

November 10, 2023
|By Bryan Tipper

Guidelines for involving subject matter experts (SMEs) and engineers in DITA-based telecom content reviews are crucial to ensuring the accuracy and technical correctness of documentation. Collaboration between technical experts and content developers is essential, and DITA provides a structured framework for this collaboration.

SME Involvement

Subject matter experts (SMEs), who possess in-depth knowledge of telecom systems and technologies, play a vital role in the review process. Guidelines typically outline how SMEs should review and validate the content. SMEs can use DITA’s review mechanisms, such as annotations and comments, to provide detailed feedback and suggestions directly within the XML content.

Engineer Participation

Engineers, who are responsible for the technical aspects of telecom systems, also participate in the review process. Guidelines may specify that engineers verify the technical accuracy of the documentation, including configurations, procedures, and troubleshooting steps. Engineers can collaborate with SMEs to ensure that the content aligns with technical standards and best practices.

Example:

Here’s an example of how guidelines can specify SME and engineer involvement in a DITA-based review:


<topic id="telecom_configuration">
  <title>Telecom Configuration</title>
  <body>
    <p>This section describes the configuration process for telecom systems.

    
    <p><note reviewer="SME">SMEs should review this section for accuracy and completeness.</note>

    
    <p><note reviewer="Engineer">Engineers must validate the technical accuracy of the configuration steps.</note>

  </body>
</topic>

In this example, DITA’s review mechanisms are used to indicate the involvement of SMEs and engineers in the review process, aligning with the established guidelines.