Hello

Ensure a clear markup between version for complex and long documents to help reduce review fatigue and improve quality.

Maintaining CHANGELOGs for engineering documentation is a challenge. Ensuring a clear commit message convention reduces complexity and improves functionality.

Using Jinja and Cookiecutter to instantly create documents in your company's style and configuration.

A scalable solution to enhance our documentation quality across large and distributed authoring teams.

You may be required to archive documents in a specific DMS system.

One document that shares content with several outputs. You could use this method where you have a single product with customer specific content blocks. Or your product is mostly similar with another product.

How we can realistically protect content whilst ensuring usability?

Using python to extract data from engineering systems, clean it, then parse it for user documentation.

A synthesized list of key tasks related to structuring and maintaining an enterprise-level documentation management system.

Using a CI/CD pipeline and Git to produce timestamped draft PDFs and DOCX files

Automatically testing and deploying documentation using a CI/CD pipeline

Quickly cleaning text and generating a readability score

Using common tools, we can quickly convert .docx or .tex files to .rst

A graphic showing the key steps in a docs-as-code workflow approach.

A simple and auditable change request workflow that incorporates merge request approvers.

We can use git-diff or a document lifecycle tool to analyze changes between any document versions.

Using GitLab as a document lifecycle tool gives us strong collaboration and change request functionality.

I use a set of open-source and well document tools to create and manage documentation at an organizational level.

We can use Regex to identify stylistic errors or asses the impact of content changes.

Using Git as a tool to version control documentation gives us complete transparency and control over content updates.

Using controlled templates to write DITA and Schema.org compliant content helps us write more functionally.

Creating documentation correctly in the first instance removes the need for secondary Quality Management Systems (QMS) or Document Management System (DMS) software. Integrating Gitlab as a DevOps tool for documentation is a lightweight and scalable way to enhance a QMS.

With the COVID-19 virus pandemic changing the way companies apply work from home policies, a Docs-as-Code approach to documentation facilitates remote collaboration on a larger scale.

General information on using Sphinx or Pandoc to create scalable technical documentation using Docs-as-Code principles.