Data Management Plan Template WORD

STANDARD OPERATING PROCEDURE: Enterprise Data Management Plan (DMP) Architecture & Word Template Provisioning

Document ID: SOP-TR-DM-8821
Effective Date: October 24, 2023
Version: 4.2.0
Review Cadence: Annual
Owner: Office of the Chief Architect, Template Registry

---

1. Executive Summary & Purpose

This Standard Operating Procedure (SOP) defines the institutional engineering standard for designing, reviewing, and deploying standardized Data Management Plan (DMP) templates in Microsoft Word (.docx) format across enterprise systems.

The purpose of this procedure is to eliminate data governance drift, enforce strict compliance with institutional data retention policies (e.g., ISO/IEC 27001, GDPR, HIPAA), and ensure that all metadata collection workflows match the programmatic ingestion standards of the Template Registry repository. Adherence to this SOP guarantees structural integrity, cross-platform compatibility, and programmatic parseability of generated DMP artifacts.

---

2. Scope & Prerequisites

2.1 Scope

This document governs all technical personnel, data stewards, and principal investigators responsible for authoring, modifying, or utilizing Word-based DMP templates within the Template Registry ecosystem.

2.2 Prerequisites & Tooling

• Software: Microsoft Word 365 (Desktop Client, v2308 or later) with developer tab enabled.
• Format Specification: Strict adherence to OpenXML (.docx) architecture; legacy .doc formats are strictly prohibited.
• Storage/Version Control: Template Registry Git-backed repository (git://registry.internal/dmp-schemas).
• Validation Utilities: Template Registry XML Schema Validator v2.1.
• Access Control: Level 3 Enterprise Configuration Management clearance.

---

3. Roles & Responsibilities (RACI Matrix)

---

4. Step-by-Step Procedure

Phase 1: Environment Preparation and Schema Initialization

• 1.1 Pull the latest baseline DMP schema definition (schema-v4.2.json) from the Template Registry repository.
• 1.2 Open Microsoft Word and initialize a blank document utilizing the enterprise master template base (TR-Master-Base.dotx).
• 1.3 Enable the Developer Tab via File > Options > Customize Ribbon > Check 'Developer'.
• 1.4 Establish the document protection profile: navigate to Review > Restrict Editing, limiting formatting to style sheets and allowing only filling in forms.

Phase 2: Structural Layout and Content Control Implementation

• 2.1 Construct Section 1: Administrative Metadata (Project Identifier, Principal Investigator, Institutional Affiliation) utilizing Rich Text Content Controls.
• 2.2 Construct Section 2: Data Description and Collection Methodology. Insert repeating table controls for multi-source dataset parameters.
• 2.3 Construct Section 3: Ethics, Legal, and Security Compliance. Embed mandatory checkbox content controls for explicit data classification (Public, Internal, Confidential, Restricted).
• 2.4 Construct Section 4: Storage, Backup, and Disaster Recovery. Assign drop-down list content controls for pre-approved cloud and on-premise storage repositories.
• 2.5 Construct Section 5: Archiving and Long-term Preservation. Define mandatory text nodes outlining preservation metadata standards (e.g., Dublin Core, DDI).

Phase 3: OpenXML Validation and Metadata Injection

• 3.1 Unzip the .docx container package locally to inspect the underlying OpenXML part structure (/word/document.xml).
• 3.2 Verify that all custom content controls possess unique w:alias and w:tag identifiers mapped directly to the DMP schema keys.
• 3.3 Strip all binary tracking artifacts and unused style definitions to minimize document bloat.
• 3.4 Re-archive the directory structure back into the .docx container format using standard ZIP compression (Deflate).
• 3.5 Execute the Template Registry CLI validation tool:

  tr-validator --file enterprise-dmp-template.docx --schema schema-v4.2.json
  

Phase 4: Registration and Release

• 4.1 Commit the validated .docx template to the central Git repository under the /templates/approved/ directory.
• 4.2 Generate the SHA-256 cryptographic checksum for the template release:

  sha256sum enterprise-dmp-template.docx > enterprise-dmp-template.docx.sha256
  

• 4.3 Update the Template Registry index manifest with the new version tag, checksum, and deployment timestamp.
• 4.4 Submit automated notification payload to the Enterprise Information Security Operations Center (ISOC).

---

5. Quality Assurance & Pro-Tips

5.1 Best Practices

• Style Overrides: Never utilize direct formatting (e.g., manual font sizing, ad-hoc hex coloring). Always utilize the globally defined Template Registry Character and Paragraph Styles.
• Compatibility Mode: Ensure the document is saved strictly in modern format mode; legacy compatibility flags trigger rendering failures in automated document parsers.

5.2 Common Pitfalls

• Broken Content Controls: Deleting the boundary markers of a Content Control rather than the internal text corrupts the underlying XML tree, causing automated ingestion APIs to fail.
• Uncompressed Media: Embedding uncompressed raster images (PNG/TIFF) into headers/footers exponentially increases file size; utilize vector-based SVG graphics exclusively.

5.3 Metric Thresholds

• Max Document Size: $\le 2.5\text{ MB}$ (unpopulated base template).
• Ingestion Parse Time: $\le 120\text{ ms}$ via the Template Registry API ingestion pipeline.
• Schema Compliance Rate: $100%$ required pass rate against the schema-v4.2.json definition.

---

6. Frequently Asked Questions (FAQ)

Q1: Why must we use Word (.docx) instead of Markdown or PDF for the master template?
A: While Markdown is utilized for technical documentation, institutional stakeholders and external funding agencies mandate Microsoft Word for its advanced typographic control, track-changes capabilities, and offline review workflows. The .docx format acts as a structured container that our backend systems can deterministically parse via OpenXML APIs.

Q2: What happens if an automated validation check fails during Phase 3?
A: The validation pipeline will generate an error log pointing to the exact XPath node failure within the document structure. The engineer must revert to the unzipped XML state, correct the malformed tag or missing content control attribute, re-archive, and re-run the validation sequence. Bypassing validation checks is a violation of institutional security protocol.