# Technical Writing, Step by Step - Olivier Carrère

## Technical writing: an industrial process

<p class="section-lead">
  How to approach technical writing as an engineering discipline &mdash; from project definition to version control, automated testing, quality validation, and delivery.
</p>

  - [**Project definition**](https://docs.redaction-technique.org/en/tech-writing-process/project-definition/): Define audience, scope, and deliverables before writing - five project parameters every technical writing engagement needs.
  - [**Integrating documentation into development**](https://docs.redaction-technique.org/en/tech-writing-process/integrating-documentation-into-development/): Treat docs like code: same release cadence, same version control, same review process.
  - [**Git: from file to content**](https://docs.redaction-technique.org/en/tech-writing-process/git-from-file-to-content/): Git stores content blobs, not filenames - understanding that model makes branching and diffing documentation much simpler.

<p class="section-more not-content">
  <a href="tech-writing-process/" class="section-more-link">
    View all 19 process articles <span class="arrow" aria-hidden="true">&rarr;</span>
  </a>
</p>

## Structured DITA XML format

<p class="section-lead">
  How structured and unstructured documentation differ &mdash; topic-based authoring, single-sourcing, and modular document architecture without vendor lock-in.
</p>

  - [**Case study: NuFirewall documentation**](https://docs.redaction-technique.org/en/formats/nufirewall-case-study/): Press reviewers cited the documentation as a product strength, not a supplement. A detailed look at the DITA XML techniques that made it possible.
  - [**Structured and unstructured formats**](https://docs.redaction-technique.org/en/formats/structured-vs-unstructured-formats/): DITA
  - [**From document to modular document base**](https://docs.redaction-technique.org/en/formats/modular-documentation/): Replace monolithic manuals with reusable topic modules: lower translation costs, parallel reviews, multiple output formats from one source pool.

<p class="section-more not-content">
  <a href="formats/" class="section-more-link">
    View all 5 formats articles <span class="arrow" aria-hidden="true">&rarr;</span>
  </a>
</p>

## The business case for structured documentation

<p class="section-lead">
  Why documentation architecture matters to an organization &mdash; maturity models, long-term maintenance costs, and technical communication economics.
</p>

  - [**From technical writing to technical communication**](https://docs.redaction-technique.org/en/costs/copywriting-to-technical-communication/): Technical communication starts before the sale - why the role spans marketing, journalism, and product documentation.
  - [**The three levels of technical documentation**](https://docs.redaction-technique.org/en/costs/three-levels-of-documentation/): A three-tier maturity model - wasteland, topic-based, structured DITA - to locate where your organization sits and what the next level costs.
  - [**Formats and tools**](https://docs.redaction-technique.org/en/costs/formats-and-tools/): Choose your source format before your tool - the format determines vendor lock-in, automation options, and long-term costs.

<p class="section-more not-content">
  <a href="costs/" class="section-more-link">
    View all 5 strategy & economics articles <span class="arrow" aria-hidden="true">&rarr;</span>
  </a>
</p>

## Tutorials

<p class="section-lead">
  Practical implementation guides and tooling &mdash; step-by-step instructions for DITA-OT, XSL-FO, Sphinx, Python regular expressions, and automation scripts.
</p>

  - [**DITA XML and XSL-FO tutorials**](https://docs.redaction-technique.org/en/tutorials/dita-xml-xsl-fo-tutorials/): Set up the DITA XML to PDF publishing chain with XSL-FO - step-by-step from source authoring to styled output.
  - [**Conditional text with Sphinx**](https://docs.redaction-technique.org/en/tutorials/conditional-text-sphinx-rest/): Generate document variants from the same ReST sources with Sphinx conditional text.
  - [**Regular expressions in Python**](https://docs.redaction-technique.org/en/tutorials/python-regular-expressions/): Python

<p class="section-more not-content">
  <a href="tutorials/" class="section-more-link">
    View all 11 tutorials <span class="arrow" aria-hidden="true">&rarr;</span>
  </a>
</p>

---

Source: https://docs.redaction-technique.org/en/
