Large-Scale Collaborative Writing: Technical Challenges and Recommendations

Markus Hofbauer, Christoph Bachhuber, Christopher B. Kuhn, Sebastian Schwarz, Bart Kroon, Eckehard Steinbach

Abstract

Collaborative writing is essential for teams that create documents together. Creating documents in large-scale collaborations is a challenging task that requires an efficient workflow. The design of such a workflow has received comparatively little attention. Conventional solutions such as working on a single Microsoft Word document or a shared online document are still widely used. In this paper, we propose a new workflow consisting of a combination of the lightweight markup language AsciiDoc together with the state-of-the-art version control system Git. The proposed process makes use of well-established workflows in the field of software development that have grown over decades. We present a detailed comparison of the proposed markup + Git workflow to Word and Word for the Web as the most prominent examples for conventional approaches. We argue that the proposed approach provides significant benefits regarding scalability, flexibility, and structuring of most collaborative writing tasks, both in academia and industry.

The Status Quo: Challenges in Traditional Collaborative Writing

Collaborative writing is a cornerstone of both academia and industry, yet the workflows used to manage it have largely stagnated. For massive projects—such as international ISO standards involving dozens of experts and hundreds of pages—the "traditional" method typically involves emailing Microsoft Word files back and forth or utilizing shared network drives.

This status quo presents several critical pain points. First, scalability is a major issue; Word documents are "monolithic" single files, making it nearly impossible for multiple authors to work on different sections simultaneously without causing merge conflicts. Second, there is a distinct lack of traceability. While Word’s "Track Changes" feature is useful for small edits, it lacks a robust, searchable history explaining why specific changes were made. Furthermore, styling inconsistencies often arise in WYSIWYG (What You See Is What You Get) editors, where accidental font or margin changes require hours of manual correction. Finally, security and intellectual property (IP) constraints often prevent high-stakes collaborations from using cloud-based tools like Google Docs, forcing teams back into inefficient manual file exchanges.

The traditional, manual workflow for collaborative writing involves significant coordination overhead and risk of version conflicts.

The Proposed Framework: Markup + Git

To address these limitations, we propose a framework based on three pillars borrowed from the software development world: lightweight markup, version control, and centralized collaboration platforms.

  1. Lightweight Markup (AsciiDoc): Unlike binary .docx files, AsciiDoc is plain text. This allows documents to be easily read by both humans and machines. Crucially, it enables "diffing"—the ability to compare changes line-by-line with total clarity.
  2. Version Control (Git): By using Git, contributors can work in isolated "branches," merging their work only when it is finalized. This enables asynchronous, parallel contributions without the fear of overwriting a colleague's work.
  3. Collaboration Platforms (GitHub/GitLab): These platforms provide "Pull Requests" (PRs), which transform document reviews into structured, archived discussions.
The proposed Git-based workflow streamlines collaboration through branching and automated pull requests.

Key Advantages of the "Documents as Code" Approach

The core philosophy of this proposal is treating a document like a software project. If Git can manage millions of lines of code across thousands of developers, it is more than capable of handling a 500-page technical manual. This approach offers several unique benefits:

  • Separation of Concerns: In a markup workflow, the author focuses strictly on content. The presentation (fonts, layout, branding) is handled by a separate rendering pipeline. This eliminates the "styling accidents" common in Word.
  • Structured Review: In traditional workflows, comments are often ephemeral. In a Git-based workflow, every change is tied to a Pull Request. The discussion remains permanently linked to that specific version of the text, providing a "legal-grade" audit trail of decisions.
  • Modularization: Because markup files are plain text, a massive document can be split into dozens of smaller files and "included" into a master document. This allows contributors to work on specific chapters in total isolation, significantly increasing project velocity.

Results and Trade-offs

When compared to local Microsoft Word and Word for the Web, the Markup + Git workflow excels in scalability and interoperability. While Word is limited by single-edit bottlenecks and proprietary binary formats, the proposed method uses open-source tools and plain text to avoid vendor lock-in.

Furthermore, the markup workflow allows for Continuous Integration (CI). Automated scripts can be configured to check for broken links, technical syntax errors, or formatting violations every time a user saves their work, preventing errors before they reach the final draft.

However, we acknowledge the "human factor" as a primary limitation. Transitioning a team of non-engineers to Git and AsciiDoc requires a shift in mindset and significant training. While Word remains superior for beginner friendliness, the technical baseline required for Git is a justifiable investment for the "well-educated employees" typically found in technical fields like ISO standardization.

Conclusion

Migrating large-scale collaborative writing away from traditional office suites toward a "markup + Git" workflow offers superior scalability, version control, and document consistency. By adopting tools from software engineering, teams can manage complex documentation projects with the same rigor and efficiency as modern software development. To facilitate this transition, we provide a GitHub template repository to act as a starting point for teams looking to modernize their writing processes.

Summary updated

Abstract

Collaborative writing is essential for teams that create documents together. Creating documents in large-scale collaborations is a challenging task that requires an efficient workflow. The design of such a workflow has received comparatively little attention. Conventional solutions such as working on a single Microsoft Word document or a shared online document are still widely used. In this paper, we propose a new workflow consisting of a combination of the lightweight markup language AsciiDoc together with the state-of-the-art version control system Git. The proposed process makes use of well-established workflows in the field of software development that have grown over decades. We present a detailed comparison of the proposed markup + Git workflow to Word and Word for the Web as the most prominent examples for conventional approaches.We argue that the proposed approach provides significant benefits regarding scalability, flexibility, and structuring of most collaborative writing tasks, both in academia and industry.
BibTeX
@misc{hofbauer2023large,
  author = {Markus Hofbauer and Christoph Bachhuber and Christopher B. Kuhn and Sebastian Schwarz and Bart Kroon and Eckehard Steinbach},
  title = {{Large-Scale Collaborative Writing: Technical Challenges and Recommendations}},
  year = {2023},
  eprint = {2303.09933},
  archivePrefix = {arXiv},
  url = {https://arxiv.org/abs/2303.09933},
}
Figure