Implementing Structured Authoring Practices in a Docs-as-Code Framework

This industry insight paper examines the transition from traditional structured authoring practices to a modern docs-as-code framework, using real-world examples based off an enterprise migration from DITA to Markdown as well as a startup technical writing team's selection of content development tools. The paper provides a comparative analysis of tools and methodologies, emphasizing the challenges and benefits of adopting docs-as-code practices in technical writing. Key areas of discussion include version control, structured authoring languages, static site generators (SSGs), deployment options, and content maintenance strategies. By comparing tools and strategies across these areas, practitioners can better understand the possibilities and constraints of taking a docs-as-code approach to structured authoring. Researchers can get insight into the decision points of practitioners when adapting emerging technologies to the theoretical frameworks of the discipline, such as component content management.

Authors

Publication Details

Published
2024-10-20
DOI
https://doi.org/10.1145/3641237.3691677
Primary Topic
Wikis in Education and Collaboration
Type
article
Field-Weighted Citation Impact
0.00
Controls
|||
ALL TIME
JAN
FEB
MAR
APR
MAY
JUN
JUL
AUG
SEP
OCT
article

Implementing Structured Authoring Practices in a Docs-as-Code Framework

Arthur Berger
Wikis in Education and Collaboration
article

Implementing Structured Authoring Practices in a Docs-as-Code Framework

Arthur Berger
article en

Abstract

This industry insight paper examines the transition from traditional structured authoring practices to a modern docs-as-code framework, using real-world examples based off an enterprise migration from DITA to Markdown as well as a startup technical writing team's selection of content development tools. The paper provides a comparative analysis of tools and methodologies, emphasizing the challenges and benefits of adopting docs-as-code practices in technical writing. Key areas of discussion include version control, structured authoring languages, static site generators (SSGs), deployment options, and content maintenance strategies. By comparing tools and strategies across these areas, practitioners can better understand the possibilities and constraints of taking a docs-as-code approach to structured authoring. Researchers can get insight into the decision points of practitioners when adapting emerging technologies to the theoretical frameworks of the discipline, such as component content management.

Openalex Percentile: Top 75%
Wikis in Education and Collaboration
AI Navigator

Ask Laika to Summarize, Analyze, and Connect papers live on the map.

Summarize Papers & Methodologies

Extract key findings, datasets, and comparative methods across publications.

Benchmark Rankings & Visual Analytics

Rank top research institutions, authors, funders, topics, and journals by Field-Weighted Citation Impact (FWCI) and paper volume with instant charts.

Connect Distant Disciplines

Bridge topological clusters on the map to find hidden collaborative intersections.