Hotspot Question Your company uses GitHub for source control. GitHub repositories store source code and store process documentation. The process documentation is saved as Microsoft Word documents that

Question

Exhibit

Answer Area

• Convert the .docx files to:Markdown (.md)
  LaTeX Typesetting (.tex)Markdown (.md)Portable Document Format (.pdf)
• Convert the flow charts to:Mermaid diagrams
  Mermaid diagramsPortable Network Graphics (.png)Tagged Image File Format (.tiff)

Explanation

This question tests knowledge of optimal file formats for storing documentation and diagrams in Git/GitHub repositories, focusing on plain-text formats that support versioning, merging, and reuse.

Approach. For the process documentation (Word documents), the correct approach is to convert them to Markdown (.md) format, which stores content as plain text, integrates natively with GitHub rendering, supports easy modification and merging via standard diff/merge tools, and eliminates the need for proprietary software. For the flow charts (BMP images embedded in Word), the correct approach is to convert them to Mermaid diagram syntax (or similar text-based diagramming language like PlantUML), which stores diagrams as plain text directly within or alongside Markdown files, minimizing file count, and enabling easy modification, merging, and reuse since diagrams are just text code rather than binary image files. This combination means both documentation and diagrams are stored as plain text, can be version-controlled with meaningful diffs, merged without binary conflicts, and reused by copying or referencing text blocks - all while GitHub natively renders both Markdown and Mermaid diagrams in the browser.

Concept tested. Optimal use of plain-text formats (Markdown and Mermaid/PlantUML) for documentation and diagramming in Git-based source control systems, enabling proper versioning, diffing, merging, and reuse of both documents and flow charts while minimizing binary file dependencies.

Reference. Microsoft Learn: Implement a versioning strategy - documentation and diagram best practices in Azure DevOps/GitHub; GitHub Docs: About Mermaid diagrams in Markdown; Git documentation on binary vs text file versioning.

No community discussion yet for this question.