{
  "version": "1.0",
  "site": "https://docs.redaction-technique.org",
  "locale": "en",
  "count": 49,
  "documents": [
    {
      "title": "Technical Writing, Step by Step - Olivier Carrère",
      "description": "Expert guides on technical writing, DITA XML, Markdown, docs-as-code, and content automation for technical communicators and documentation engineering teams.",
      "url": "https://docs.redaction-technique.org/en/",
      "markdown": "https://docs.redaction-technique.org/en.md",
      "locale": "en",
      "wordCount": 148,
      "headings": [
        {
          "level": 2,
          "text": "Technical writing: an industrial process",
          "slug": "technical-writing-an-industrial-process"
        },
        {
          "level": 2,
          "text": "Structured DITA XML format",
          "slug": "structured-dita-xml-format"
        },
        {
          "level": 2,
          "text": "The business case for structured documentation",
          "slug": "the-business-case-for-structured-documentation"
        },
        {
          "level": 2,
          "text": "Tutorials",
          "slug": "tutorials"
        }
      ],
      "keywords": [],
      "tags": []
    },
    {
      "title": "About this blog",
      "description": "A technical writing blog specializing in DITA XML, docs-as-code, documentation automation, and technical communication, by Olivier Carrère, technical writer.",
      "url": "https://docs.redaction-technique.org/en/about-this-blog/",
      "markdown": "https://docs.redaction-technique.org/en/about-this-blog.md",
      "locale": "en",
      "wordCount": 590,
      "headings": [
        {
          "level": 2,
          "text": "Free your information from its silos",
          "slug": "free-your-information-from-its-silos"
        },
        {
          "level": 3,
          "text": "Integrate documentation into the development process",
          "slug": "integrate-documentation-into-the-development-process"
        },
        {
          "level": 3,
          "text": "This blog’s sources are managed under Git",
          "slug": "this-blogs-sources-are-managed-under-git"
        },
        {
          "level": 3,
          "text": "Source formats",
          "slug": "source-formats"
        },
        {
          "level": 3,
          "text": "Target formats",
          "slug": "target-formats"
        }
      ],
      "keywords": [],
      "tags": []
    },
    {
      "title": "Project definition",
      "description": "Define your technical documentation project before writing: identify the audience, scope, deliverables, and success criteria to guide the entire editorial process.",
      "url": "https://docs.redaction-technique.org/en/tech-writing-process/project-definition/",
      "markdown": "https://docs.redaction-technique.org/en/tech-writing-process/project-definition.md",
      "locale": "en",
      "wordCount": 279,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "technical-writing"
      ],
      "tags": [
        "technical-writing"
      ]
    },
    {
      "title": "Gathering information",
      "description": "How technical writers gather information: expert interviews, product testing, existing documentation, and field observations to build accurate and useful content.",
      "url": "https://docs.redaction-technique.org/en/tech-writing-process/gathering-information/",
      "markdown": "https://docs.redaction-technique.org/en/tech-writing-process/gathering-information.md",
      "locale": "en",
      "wordCount": 222,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "technical-writing"
      ],
      "tags": [
        "technical-writing"
      ]
    },
    {
      "title": "Testing products to document them",
      "description": "A technical writer must test the product in real user conditions before documenting it, not merely compile what stakeholders say - cutting through their partial views and the information loss that undermines accuracy.",
      "url": "https://docs.redaction-technique.org/en/tech-writing-process/testing-products/",
      "markdown": "https://docs.redaction-technique.org/en/tech-writing-process/testing-products.md",
      "locale": "en",
      "wordCount": 511,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "technical-writing"
      ],
      "tags": [
        "technical-writing"
      ]
    },
    {
      "title": "Source format",
      "description": "Word processors have unaccustomed us to distinguishing between form and content. But confusing the two leads to many errors and wasted time.",
      "url": "https://docs.redaction-technique.org/en/tech-writing-process/source-format/",
      "markdown": "https://docs.redaction-technique.org/en/tech-writing-process/source-format.md",
      "locale": "en",
      "wordCount": 1385,
      "headings": [
        {
          "level": 2,
          "text": "Monolithic or modular documents",
          "slug": "monolithic-or-modular-documents"
        },
        {
          "level": 3,
          "text": "Markdown as a source format",
          "slug": "markdown-as-a-source-format"
        },
        {
          "level": 3,
          "text": "What is an information module?",
          "slug": "what-is-an-information-module"
        },
        {
          "level": 2,
          "text": "Binary or text files",
          "slug": "binary-or-text-files"
        },
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        },
        {
          "level": 2,
          "text": "Related reading",
          "slug": "related-reading"
        }
      ],
      "keywords": [
        "technical-writing",
        "structured-authoring"
      ],
      "tags": [
        "technical-writing",
        "structured-authoring"
      ]
    },
    {
      "title": "Target format",
      "description": "The target format is what end users consume - PDF, HTML, or compiled help - generated from a single source. Learn the difference between fully automatic, semi-automatic, and manual publishing.",
      "url": "https://docs.redaction-technique.org/en/tech-writing-process/target-format/",
      "markdown": "https://docs.redaction-technique.org/en/tech-writing-process/target-format.md",
      "locale": "en",
      "wordCount": 263,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "technical-writing"
      ],
      "tags": [
        "technical-writing"
      ]
    },
    {
      "title": "Content creation",
      "description": "The technical writer creates the content of the technical writing project in constant dialogue with the company's various stakeholders, such as R&D and marketing.",
      "url": "https://docs.redaction-technique.org/en/tech-writing-process/content-creation/",
      "markdown": "https://docs.redaction-technique.org/en/tech-writing-process/content-creation.md",
      "locale": "en",
      "wordCount": 130,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "technical-writing"
      ],
      "tags": [
        "technical-writing"
      ]
    },
    {
      "title": "Integrating documentation into development processes",
      "description": "Learn why technical documentation should be released, versioned, and quality-controlled alongside the product, using text formats like DocBook, DITA XML, and reStructuredText.",
      "url": "https://docs.redaction-technique.org/en/tech-writing-process/integrating-documentation-into-development/",
      "markdown": "https://docs.redaction-technique.org/en/tech-writing-process/integrating-documentation-into-development.md",
      "locale": "en",
      "wordCount": 258,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        },
        {
          "level": 2,
          "text": "Related reading",
          "slug": "related-reading"
        }
      ],
      "keywords": [
        "git",
        "docs-as-code"
      ],
      "tags": [
        "git",
        "docs-as-code"
      ]
    },
    {
      "title": "Version management systems - rustic but reliable",
      "description": "Use Git or Subversion to manage technical documentation like source code: track changes, collaborate with your team, and roll back safely at any time.",
      "url": "https://docs.redaction-technique.org/en/tech-writing-process/version-control-systems/",
      "markdown": "https://docs.redaction-technique.org/en/tech-writing-process/version-control-systems.md",
      "locale": "en",
      "wordCount": 476,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        },
        {
          "level": 2,
          "text": "Related reading",
          "slug": "related-reading"
        }
      ],
      "keywords": [
        "git",
        "version-control",
        "docs-as-code"
      ],
      "tags": [
        "git",
        "version-control",
        "docs-as-code"
      ]
    },
    {
      "title": "Git: from file to content",
      "description": "Think content rather than files with Git: branches, commits, and diffs for technical documentation make collaboration and version management far simpler and safer.",
      "url": "https://docs.redaction-technique.org/en/tech-writing-process/git-from-file-to-content/",
      "markdown": "https://docs.redaction-technique.org/en/tech-writing-process/git-from-file-to-content.md",
      "locale": "en",
      "wordCount": 1270,
      "headings": [
        {
          "level": 2,
          "text": "Overcoming documentation bottlenecks with Git branches",
          "slug": "overcoming-documentation-bottlenecks-with-git-branches"
        },
        {
          "level": 2,
          "text": "Organizing your history with git rebase",
          "slug": "organizing-your-history-with-git-rebase"
        },
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        },
        {
          "level": 2,
          "text": "Related reading",
          "slug": "related-reading"
        }
      ],
      "keywords": [
        "git",
        "version-control",
        "docs-as-code"
      ],
      "tags": [
        "git",
        "version-control",
        "docs-as-code"
      ]
    },
    {
      "title": "Using branches in source management systems",
      "description": "Use Git branches to manage parallel documentation projects, product variants, and translation workflows without conflicts - a practical guide for technical writers.",
      "url": "https://docs.redaction-technique.org/en/tech-writing-process/using-branches/",
      "markdown": "https://docs.redaction-technique.org/en/tech-writing-process/using-branches.md",
      "locale": "en",
      "wordCount": 332,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "git",
        "version-control",
        "translation"
      ],
      "tags": [
        "git",
        "version-control",
        "translation"
      ]
    },
    {
      "title": "Repository",
      "description": "Content is a company's intangible capital. Learn how to choose and manage a documentation repository to protect, version, and share technical content across teams.",
      "url": "https://docs.redaction-technique.org/en/tech-writing-process/repository/",
      "markdown": "https://docs.redaction-technique.org/en/tech-writing-process/repository.md",
      "locale": "en",
      "wordCount": 91,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "git",
        "version-control"
      ],
      "tags": [
        "git",
        "version-control"
      ]
    },
    {
      "title": "A single repository?",
      "description": "A single Git repository for all technical documentation content maximizes reuse, consistency, and quality while simplifying collaboration across writing and dev teams.",
      "url": "https://docs.redaction-technique.org/en/tech-writing-process/single-repository/",
      "markdown": "https://docs.redaction-technique.org/en/tech-writing-process/single-repository.md",
      "locale": "en",
      "wordCount": 194,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "git",
        "version-control"
      ],
      "tags": [
        "git",
        "version-control"
      ]
    },
    {
      "title": "Which repository for group work?",
      "description": "Why folders and shared network drives fall short for collaborative technical writing: concurrent edits overwrite one another and file locking blocks batch changes - problems that version-control systems solve reliably.",
      "url": "https://docs.redaction-technique.org/en/tech-writing-process/which-repository-for-group-work/",
      "markdown": "https://docs.redaction-technique.org/en/tech-writing-process/which-repository-for-group-work.md",
      "locale": "en",
      "wordCount": 413,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "version-control"
      ],
      "tags": [
        "version-control"
      ]
    },
    {
      "title": "Shared network directories - unsuitable for group work",
      "description": "Shared network drives are a common but inadequate solution for team documentation collaboration. Learn why they fail and what version-control alternatives work better.",
      "url": "https://docs.redaction-technique.org/en/tech-writing-process/shared-network-directories/",
      "markdown": "https://docs.redaction-technique.org/en/tech-writing-process/shared-network-directories.md",
      "locale": "en",
      "wordCount": 359,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "version-control"
      ],
      "tags": [
        "version-control"
      ]
    },
    {
      "title": "SQL database",
      "description": "In a CMS like Drupal, Joomla, or WordPress, technical content lives in an SQL database that keeps only per-article history and cannot search and replace across all content - one reason to manage it as text files instead.",
      "url": "https://docs.redaction-technique.org/en/tech-writing-process/sql-database/",
      "markdown": "https://docs.redaction-technique.org/en/tech-writing-process/sql-database.md",
      "locale": "en",
      "wordCount": 99,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "version-control"
      ],
      "tags": [
        "version-control"
      ]
    },
    {
      "title": "CMS: workflow as a bonus, but reliability to be tested",
      "description": "A CMS like SharePoint or Alfresco adds workflow and file-locking to technical writing, and some (DocZone, Componize) even handle DITA XML - but their reliability for archiving source files must be tested and backed by a solid backup strategy.",
      "url": "https://docs.redaction-technique.org/en/tech-writing-process/cms-workflow-and-reliability/",
      "markdown": "https://docs.redaction-technique.org/en/tech-writing-process/cms-workflow-and-reliability.md",
      "locale": "en",
      "wordCount": 237,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "version-control"
      ],
      "tags": [
        "version-control"
      ]
    },
    {
      "title": "Validation and quality control",
      "description": "Validate technical documentation before delivery: run validation in parallel with writing, track every change request through a CMS workflow or a ticketing system, and use comparison tools to review updates reliably.",
      "url": "https://docs.redaction-technique.org/en/tech-writing-process/validation-quality-control/",
      "markdown": "https://docs.redaction-technique.org/en/tech-writing-process/validation-quality-control.md",
      "locale": "en",
      "wordCount": 471,
      "headings": [
        {
          "level": 2,
          "text": "Creation and validation workflow",
          "slug": "creation-and-validation-workflow"
        },
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "technical-writing"
      ],
      "tags": [
        "technical-writing"
      ]
    },
    {
      "title": "Translation",
      "description": "Plan translation from the start of your documentation project: tackle it early to cut costs and delivery times, translate modular content in parallel with writing, and organize source repositories language-first.",
      "url": "https://docs.redaction-technique.org/en/tech-writing-process/translation/",
      "markdown": "https://docs.redaction-technique.org/en/tech-writing-process/translation.md",
      "locale": "en",
      "wordCount": 334,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        },
        {
          "level": 2,
          "text": "Related reading",
          "slug": "related-reading"
        }
      ],
      "keywords": [
        "translation"
      ],
      "tags": [
        "translation"
      ]
    },
    {
      "title": "Delivery",
      "description": "Delivery is the final step: validated content reaches its audiences through the format and channel chosen at project definition, from animations and brochures to newsletters, website updates, and printed or PDF guides.",
      "url": "https://docs.redaction-technique.org/en/tech-writing-process/delivery/",
      "markdown": "https://docs.redaction-technique.org/en/tech-writing-process/delivery.md",
      "locale": "en",
      "wordCount": 90,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "technical-writing"
      ],
      "tags": [
        "technical-writing"
      ]
    },
    {
      "title": "Technical writing: an industrial process",
      "description": "Explore the complete technical writing process: project definition, information gathering, content creation, validation, translation, and delivery to end users.",
      "url": "https://docs.redaction-technique.org/en/tech-writing-process/",
      "markdown": "https://docs.redaction-technique.org/en/tech-writing-process.md",
      "locale": "en",
      "wordCount": 232,
      "headings": [],
      "keywords": [],
      "tags": []
    },
    {
      "title": "Auto-insert data into a DITA XML file",
      "description": "Automate DITA XML file generation with Python: dynamically insert product data into DITA topics to industrialize technical documentation.",
      "url": "https://docs.redaction-technique.org/en/tutorials/auto-insert-data-dita-xml/",
      "markdown": "https://docs.redaction-technique.org/en/tutorials/auto-insert-data-dita-xml.md",
      "locale": "en",
      "wordCount": 176,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "dita-xml",
        "python",
        "automation"
      ],
      "tags": [
        "dita-xml",
        "python",
        "automation"
      ]
    },
    {
      "title": "Automatically insert data into a reStructuredText file",
      "description": "Automatically insert product data into reStructuredText documentation with Python - generate per-product version lists from structured data files.",
      "url": "https://docs.redaction-technique.org/en/tutorials/auto-insert-data-restructuredtext/",
      "markdown": "https://docs.redaction-technique.org/en/tutorials/auto-insert-data-restructuredtext.md",
      "locale": "en",
      "wordCount": 259,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        },
        {
          "level": 2,
          "text": "Related reading",
          "slug": "related-reading"
        }
      ],
      "keywords": [
        "python",
        "automation"
      ],
      "tags": [
        "python",
        "automation"
      ]
    },
    {
      "title": "Automatically insert SQL data into a reStructuredText file",
      "description": "Create a product database with Python and SQLite, then automatically generate formatted reStructuredText documentation from the data - a practical docs-as-code tutorial.",
      "url": "https://docs.redaction-technique.org/en/tutorials/auto-insert-sql-data-restructuredtext/",
      "markdown": "https://docs.redaction-technique.org/en/tutorials/auto-insert-sql-data-restructuredtext.md",
      "locale": "en",
      "wordCount": 371,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        },
        {
          "level": 2,
          "text": "Related reading",
          "slug": "related-reading"
        }
      ],
      "keywords": [
        "python",
        "automation"
      ],
      "tags": [
        "python",
        "automation"
      ]
    },
    {
      "title": "Create different documents from the same ReST sources (conditional text)",
      "description": "Generate multiple document variants - user guide, admin guide, lite edition - from the same reStructuredText sources using Sphinx conditional text directives.",
      "url": "https://docs.redaction-technique.org/en/tutorials/conditional-text-sphinx-rest/",
      "markdown": "https://docs.redaction-technique.org/en/tutorials/conditional-text-sphinx-rest.md",
      "locale": "en",
      "wordCount": 171,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "automation"
      ],
      "tags": [
        "automation"
      ]
    },
    {
      "title": "Create different documents from the same sources using Jinja",
      "description": "Profile reStructuredText content with Jinja and a Python preprocessing script to generate audience-specific document variants - user, admin, lite - from a single source.",
      "url": "https://docs.redaction-technique.org/en/tutorials/conditional-text-jinja/",
      "markdown": "https://docs.redaction-technique.org/en/tutorials/conditional-text-jinja.md",
      "locale": "en",
      "wordCount": 94,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "python",
        "automation"
      ],
      "tags": [
        "python",
        "automation"
      ]
    },
    {
      "title": "Create different documents from the same sources via Jinja (object method)",
      "description": "Profile content with Jinja by defining objects (audience, platform, version) to include or exclude blocks according to their attributes using a Python profiling script.",
      "url": "https://docs.redaction-technique.org/en/tutorials/conditional-text-jinja-object-method/",
      "markdown": "https://docs.redaction-technique.org/en/tutorials/conditional-text-jinja-object-method.md",
      "locale": "en",
      "wordCount": 903,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "python",
        "automation"
      ],
      "tags": [
        "python",
        "automation"
      ]
    },
    {
      "title": "DITA XML and XSL-FO tutorials",
      "description": "DITA XML structured authoring tutorials and XSL-FO stylesheet guides: create topic-based documentation and apply professional layouts for PDF and print output.",
      "url": "https://docs.redaction-technique.org/en/tutorials/dita-xml-xsl-fo-tutorials/",
      "markdown": "https://docs.redaction-technique.org/en/tutorials/dita-xml-xsl-fo-tutorials.md",
      "locale": "en",
      "wordCount": 2854,
      "headings": [
        {
          "level": 2,
          "text": "XSL-FO: Filter content according to \"except\" and \"or\" conditions",
          "slug": "xsl-fo-filter-content-according-to-except-and-or-conditions"
        },
        {
          "level": 2,
          "text": "XSL-FO: Automatically insert a title for examples",
          "slug": "xsl-fo-automatically-insert-a-title-for-examples"
        },
        {
          "level": 3,
          "text": "Automatically insert a text variable before the title of examples",
          "slug": "automatically-insert-a-text-variable-before-the-title-of-examples"
        },
        {
          "level": 2,
          "text": "Generate a PDF with DITA Open Toolkit under GNU/Linux",
          "slug": "generate-a-pdf-with-dita-open-toolkit-under-gnulinux"
        },
        {
          "level": 2,
          "text": "Generate a PDF with DITA Open Toolkit (Windows)",
          "slug": "generate-a-pdf-with-dita-open-toolkit-windows"
        },
        {
          "level": 2,
          "text": "Manage multilingual DITA XML documentation projects",
          "slug": "manage-multilingual-dita-xml-documentation-projects"
        },
        {
          "level": 3,
          "text": "Methodology for multilingual DITA XML documentation projects",
          "slug": "methodology-for-multilingual-dita-xml-documentation-projects"
        },
        {
          "level": 2,
          "text": "Create different documents from the same DITA sources",
          "slug": "create-different-documents-from-the-same-dita-sources"
        },
        {
          "level": 2,
          "text": "DITA Open Toolkit: Display cross-references in PDFs",
          "slug": "dita-open-toolkit-display-cross-references-in-pdfs"
        },
        {
          "level": 2,
          "text": "Display an Index in PDF",
          "slug": "display-an-index-in-pdf"
        },
        {
          "level": 2,
          "text": "Use the nXML IDE for DITA XML",
          "slug": "use-the-nxml-ide-for-dita-xml"
        },
        {
          "level": 2,
          "text": "Speed up your typing with Predictive mode for Emacs",
          "slug": "speed-up-your-typing-with-predictive-mode-for-emacs"
        },
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "dita-xml"
      ],
      "tags": [
        "dita-xml"
      ]
    },
    {
      "title": "Managing a project from start to finish",
      "description": "It's pretty rare, in a professional context, to be able to manage a project from (almost) A to Z, from conception to realization and communication.",
      "url": "https://docs.redaction-technique.org/en/tutorials/project-end-to-end/",
      "markdown": "https://docs.redaction-technique.org/en/tutorials/project-end-to-end.md",
      "locale": "en",
      "wordCount": 2184,
      "headings": [
        {
          "level": 2,
          "text": "Photo management for a non-profit",
          "slug": "photo-management-for-a-non-profit"
        },
        {
          "level": 2,
          "text": "Retrieving and sorting photos",
          "slug": "retrieving-and-sorting-photos"
        },
        {
          "level": 2,
          "text": "Centralized photo gallery in the cloud",
          "slug": "centralized-photo-gallery-in-the-cloud"
        },
        {
          "level": 2,
          "text": "Photo indexing",
          "slug": "photo-indexing"
        },
        {
          "level": 2,
          "text": "Incremental and decentralized backup",
          "slug": "incremental-and-decentralized-backup"
        },
        {
          "level": 2,
          "text": "Definition of a photo management workflow",
          "slug": "definition-of-a-photo-management-workflow"
        },
        {
          "level": 2,
          "text": "Definition of roles for photo workflow members",
          "slug": "definition-of-roles-for-photo-workflow-members"
        },
        {
          "level": 2,
          "text": "Internal communication",
          "slug": "internal-communication"
        },
        {
          "level": 2,
          "text": "Video tutorials",
          "slug": "video-tutorials"
        },
        {
          "level": 2,
          "text": "Paper support",
          "slug": "paper-support"
        },
        {
          "level": 2,
          "text": "LaTeX",
          "slug": "latex"
        },
        {
          "level": 2,
          "text": "Track changes with Git",
          "slug": "track-changes-with-git"
        },
        {
          "level": 2,
          "text": "Editorial style",
          "slug": "editorial-style"
        },
        {
          "level": 2,
          "text": "Iconography",
          "slug": "iconography"
        },
        {
          "level": 2,
          "text": "Patience",
          "slug": "patience"
        },
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        },
        {
          "level": 2,
          "text": "Related reading",
          "slug": "related-reading"
        }
      ],
      "keywords": [
        "python",
        "automation"
      ],
      "tags": [
        "python",
        "automation"
      ]
    },
    {
      "title": "Regular expressions in Python",
      "description": "Use Python's re library to search, extract, and transform text in documentation files - a practical regex guide for technical writers working with automation scripts.",
      "url": "https://docs.redaction-technique.org/en/tutorials/python-regular-expressions/",
      "markdown": "https://docs.redaction-technique.org/en/tutorials/python-regular-expressions.md",
      "locale": "en",
      "wordCount": 85,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "python",
        "automation"
      ],
      "tags": [
        "python",
        "automation"
      ]
    },
    {
      "title": "sed: modify your text without opening your files",
      "description": "Learn to use sed, the Unix stream editor, to batch-edit technical documentation files without opening them - perfect for automating repetitive content updates.",
      "url": "https://docs.redaction-technique.org/en/tutorials/sed-text-editing/",
      "markdown": "https://docs.redaction-technique.org/en/tutorials/sed-text-editing.md",
      "locale": "en",
      "wordCount": 1237,
      "headings": [
        {
          "level": 2,
          "text": "Molière and GNU/Linux",
          "slug": "molire-and-gnulinux"
        },
        {
          "level": 2,
          "text": "Much ado...",
          "slug": "much-ado"
        },
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "automation"
      ],
      "tags": [
        "automation"
      ]
    },
    {
      "title": "The Raspberry Pi 3 as a documentation platform",
      "description": "Set up a complete documentation platform on a Raspberry Pi 3: install Sphinx, generate PDF, HTML, and EPUB from reStructuredText, and manage content with Git.",
      "url": "https://docs.redaction-technique.org/en/tutorials/raspberry-pi-documentation-platform/",
      "markdown": "https://docs.redaction-technique.org/en/tutorials/raspberry-pi-documentation-platform.md",
      "locale": "en",
      "wordCount": 1089,
      "headings": [
        {
          "level": 2,
          "text": "Configure the Raspberry Pi 3",
          "slug": "configure-the-raspberry-pi-3"
        },
        {
          "level": 2,
          "text": "Install the software needed to manage this blog",
          "slug": "install-the-software-needed-to-manage-this-blog"
        },
        {
          "level": 2,
          "text": "Get the sources for this blog",
          "slug": "get-the-sources-for-this-blog"
        },
        {
          "level": 2,
          "text": "Create and modify text",
          "slug": "create-and-modify-text"
        },
        {
          "level": 2,
          "text": "Create and modify diagrams",
          "slug": "create-and-modify-diagrams"
        },
        {
          "level": 2,
          "text": "Manage your documentation versions",
          "slug": "manage-your-documentation-versions"
        },
        {
          "level": 2,
          "text": "Generate your documentation",
          "slug": "generate-your-documentation"
        },
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "python",
        "automation",
        "git"
      ],
      "tags": [
        "python",
        "automation",
        "git"
      ]
    },
    {
      "title": "Tutorials",
      "description": "Practical guides for automating, authoring, and publishing technical documentation with Python, Jinja, reStructuredText, and DITA XML.",
      "url": "https://docs.redaction-technique.org/en/tutorials/",
      "markdown": "https://docs.redaction-technique.org/en/tutorials.md",
      "locale": "en",
      "wordCount": 67,
      "headings": [
        {
          "level": 2,
          "text": "Structured authoring and single-sourcing",
          "slug": "structured-authoring-and-single-sourcing"
        },
        {
          "level": 2,
          "text": "Content automation and data integration",
          "slug": "content-automation-and-data-integration"
        },
        {
          "level": 2,
          "text": "Text processing and platform tooling",
          "slug": "text-processing-and-platform-tooling"
        }
      ],
      "keywords": [],
      "tags": []
    },
    {
      "title": "Case studies in using DITA XML",
      "description": "Practical DITA XML solutions and tips developed through daily multilingual technical writing projects - structured authoring, topic reuse, conditional text, and publishing.",
      "url": "https://docs.redaction-technique.org/en/formats/dita-xml-case-studies/",
      "markdown": "https://docs.redaction-technique.org/en/formats/dita-xml-case-studies.md",
      "locale": "en",
      "wordCount": 118,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        },
        {
          "level": 2,
          "text": "Related reading",
          "slug": "related-reading"
        }
      ],
      "keywords": [
        "dita-xml",
        "translation"
      ],
      "tags": [
        "dita-xml",
        "translation"
      ]
    },
    {
      "title": "Case study: NuFirewall documentation",
      "description": "NuFirewall's documentation, praised by the press as a product strength, was built with DITA XML - a case study in structured authoring for software product documentation.",
      "url": "https://docs.redaction-technique.org/en/formats/nufirewall-case-study/",
      "markdown": "https://docs.redaction-technique.org/en/formats/nufirewall-case-study.md",
      "locale": "en",
      "wordCount": 1705,
      "headings": [
        {
          "level": 2,
          "text": "Reusing information blocks with conrefs",
          "slug": "reusing-information-blocks-with-conrefs"
        },
        {
          "level": 3,
          "text": "Centralize conrefs in a single file",
          "slug": "centralize-conrefs-in-a-single-file"
        },
        {
          "level": 3,
          "text": "Use the lowest-level XML node",
          "slug": "use-the-lowest-level-xml-node"
        },
        {
          "level": 3,
          "text": "Consider translation constraints",
          "slug": "consider-translation-constraints"
        },
        {
          "level": 3,
          "text": "Limit conref nesting",
          "slug": "limit-conref-nesting"
        },
        {
          "level": 3,
          "text": "Maximize conref use to reduce costs",
          "slug": "maximize-conref-use-to-reduce-costs"
        },
        {
          "level": 3,
          "text": "Protect confidential information",
          "slug": "protect-confidential-information"
        },
        {
          "level": 2,
          "text": "Provide targeted information with Ditaval conditional text",
          "slug": "provide-targeted-information-with-ditaval-conditional-text"
        },
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "dita-xml"
      ],
      "tags": [
        "dita-xml"
      ]
    },
    {
      "title": "From document to modular document base",
      "description": "DITA XML structured authoring moves documentation from monolithic books to a modular content base, enabling topic reuse, efficient translation, and multichannel output.",
      "url": "https://docs.redaction-technique.org/en/formats/modular-documentation/",
      "markdown": "https://docs.redaction-technique.org/en/formats/modular-documentation.md",
      "locale": "en",
      "wordCount": 1653,
      "headings": [
        {
          "level": 2,
          "text": "DITA XML: a tag-based structured markup language",
          "slug": "dita-xml-a-tag-based-structured-markup-language"
        },
        {
          "level": 2,
          "text": "DITA information types: concept, task, and reference",
          "slug": "dita-information-types-concept-task-and-reference"
        },
        {
          "level": 2,
          "text": "On-demand DITA content assembly with ditamaps",
          "slug": "on-demand-dita-content-assembly-with-ditamaps"
        },
        {
          "level": 2,
          "text": "Single-sourcing: One source, multiple targets",
          "slug": "single-sourcing-one-source-multiple-targets"
        },
        {
          "level": 2,
          "text": "Topics: Basic DITA XML information modules",
          "slug": "topics-basic-dita-xml-information-modules"
        },
        {
          "level": 2,
          "text": "Managing DITA XML content with or without a CMS?",
          "slug": "managing-dita-xml-content-with-or-without-a-cms"
        },
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        },
        {
          "level": 2,
          "text": "Related reading",
          "slug": "related-reading"
        }
      ],
      "keywords": [
        "dita-xml",
        "structured-authoring"
      ],
      "tags": [
        "dita-xml",
        "structured-authoring"
      ]
    },
    {
      "title": "Structured and unstructured formats",
      "description": "Compare structured formats (DITA XML, DocBook) and unstructured formats (Word, PDF) for technical documentation: understand the trade-offs for reuse and translation.",
      "url": "https://docs.redaction-technique.org/en/formats/structured-vs-unstructured-formats/",
      "markdown": "https://docs.redaction-technique.org/en/formats/structured-vs-unstructured-formats.md",
      "locale": "en",
      "wordCount": 2067,
      "headings": [
        {
          "level": 2,
          "text": "DocBook vs DITA XML: choosing a structured authoring format",
          "slug": "docbook-vs-dita-xml-choosing-a-structured-authoring-format"
        },
        {
          "level": 2,
          "text": "Migrating from FrameMaker to DITA XML",
          "slug": "migrating-from-framemaker-to-dita-xml"
        },
        {
          "level": 3,
          "text": "Restructuring FrameMaker content",
          "slug": "restructuring-framemaker-content"
        },
        {
          "level": 3,
          "text": "The FrameMaker-to-DITA XML conversion table",
          "slug": "the-framemaker-to-dita-xml-conversion-table"
        },
        {
          "level": 3,
          "text": "A step-by-step migration procedure",
          "slug": "a-step-by-step-migration-procedure"
        },
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        },
        {
          "level": 2,
          "text": "Related reading",
          "slug": "related-reading"
        }
      ],
      "keywords": [
        "dita-xml",
        "structured-authoring"
      ],
      "tags": [
        "dita-xml",
        "structured-authoring"
      ]
    },
    {
      "title": "Structured DITA XML format",
      "description": "Reduce production costs and delivery time in technical documentation by choosing the right format, structured authoring approach, and modular content reuse strategies.",
      "url": "https://docs.redaction-technique.org/en/formats/",
      "markdown": "https://docs.redaction-technique.org/en/formats.md",
      "locale": "en",
      "wordCount": 339,
      "headings": [],
      "keywords": [],
      "tags": []
    },
    {
      "title": "Too complex a document architecture?",
      "description": "DITA XML enables productivity gains by reducing the source volume that the technical writer creates, translates and maintains, at the cost of greater complexity.",
      "url": "https://docs.redaction-technique.org/en/formats/document-architecture-complexity/",
      "markdown": "https://docs.redaction-technique.org/en/formats/document-architecture-complexity.md",
      "locale": "en",
      "wordCount": 248,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "dita-xml",
        "structured-authoring"
      ],
      "tags": [
        "dita-xml",
        "structured-authoring"
      ]
    },
    {
      "title": "Formats and tools",
      "description": "When industrializing technical writing, the format matters more than the tool. Compare proprietary formats like Word and FrameMaker against open standards like DITA XML and DocBook to find the right fit.",
      "url": "https://docs.redaction-technique.org/en/costs/formats-and-tools/",
      "markdown": "https://docs.redaction-technique.org/en/costs/formats-and-tools.md",
      "locale": "en",
      "wordCount": 283,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        },
        {
          "level": 2,
          "text": "Related reading",
          "slug": "related-reading"
        }
      ],
      "keywords": [
        "dita-xml",
        "structured-authoring",
        "technical-writing"
      ],
      "tags": [
        "dita-xml",
        "structured-authoring",
        "technical-writing"
      ]
    },
    {
      "title": "From technical writing to technical communication",
      "description": "Technical communication is often reduced to technical writing. Technical writing provides product documentation and sits downstream of the sale.",
      "url": "https://docs.redaction-technique.org/en/costs/copywriting-to-technical-communication/",
      "markdown": "https://docs.redaction-technique.org/en/costs/copywriting-to-technical-communication.md",
      "locale": "en",
      "wordCount": 412,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "technical-writing"
      ],
      "tags": [
        "technical-writing"
      ]
    },
    {
      "title": "Is an index useful in a PDF?",
      "description": "Is an index still useful in a PDF manual in the age of full-text search? Explore the pros and cons for technical documentation and help content usability.",
      "url": "https://docs.redaction-technique.org/en/costs/index-in-pdf/",
      "markdown": "https://docs.redaction-technique.org/en/costs/index-in-pdf.md",
      "locale": "en",
      "wordCount": 268,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "technical-writing"
      ],
      "tags": [
        "technical-writing"
      ]
    },
    {
      "title": "KISS Principle of Simplicity",
      "description": "The KISS principle (Keep it simple stupid) is a general engineering principle that advocates simplicity to improve reliability, maintenance and scalability.",
      "url": "https://docs.redaction-technique.org/en/costs/kiss-principle/",
      "markdown": "https://docs.redaction-technique.org/en/costs/kiss-principle.md",
      "locale": "en",
      "wordCount": 350,
      "headings": [
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        },
        {
          "level": 2,
          "text": "Related reading",
          "slug": "related-reading"
        }
      ],
      "keywords": [
        "technical-writing"
      ],
      "tags": [
        "technical-writing"
      ]
    },
    {
      "title": "Technical documentation: reduce costs, improve customer satisfaction",
      "description": "Reduce documentation costs, accelerate time to market, and improve quality through industrial technical writing practices, modular content, and structured authoring.",
      "url": "https://docs.redaction-technique.org/en/costs/",
      "markdown": "https://docs.redaction-technique.org/en/costs.md",
      "locale": "en",
      "wordCount": 222,
      "headings": [],
      "keywords": [],
      "tags": []
    },
    {
      "title": "The three levels of technical documentation",
      "description": "Compare the three maturity levels of technical documentation - from informal notes to modular structured content - and see what sets each stage apart.",
      "url": "https://docs.redaction-technique.org/en/costs/three-levels-of-documentation/",
      "markdown": "https://docs.redaction-technique.org/en/costs/three-levels-of-documentation.md",
      "locale": "en",
      "wordCount": 334,
      "headings": [
        {
          "level": 2,
          "text": "Level 1: the wasteland",
          "slug": "level-1-the-wasteland"
        },
        {
          "level": 2,
          "text": "Level 2: the English garden — topic-based documentation",
          "slug": "level-2-the-english-garden-topic-based-documentation"
        },
        {
          "level": 2,
          "text": "Level 3: the French garden — structured DITA XML",
          "slug": "level-3-the-french-garden-structured-dita-xml"
        },
        {
          "level": 2,
          "text": "Related articles",
          "slug": "related-articles"
        }
      ],
      "keywords": [
        "technical-writing",
        "structured-authoring"
      ],
      "tags": [
        "technical-writing",
        "structured-authoring"
      ]
    },
    {
      "title": "Ask the documentation",
      "description": "Ask a question about the technical writing documentation and get an AI-generated answer based on the site's content.",
      "url": "https://docs.redaction-technique.org/en/ask/",
      "markdown": "https://docs.redaction-technique.org/en/ask.md",
      "locale": "en",
      "wordCount": 0,
      "headings": [],
      "keywords": [],
      "tags": []
    },
    {
      "title": "Example Guide",
      "description": "A step-by-step guide to technical writing workflows, structured authoring, and documentation automation for software and product documentation teams.",
      "url": "https://docs.redaction-technique.org/guides/example/",
      "markdown": "https://docs.redaction-technique.org/guides/example.md",
      "locale": "en",
      "wordCount": 44,
      "headings": [
        {
          "level": 2,
          "text": "Further reading",
          "slug": "further-reading"
        }
      ],
      "keywords": [],
      "tags": []
    },
    {
      "title": "Example Reference",
      "description": "Reference documentation for technical writing tools, formats, and workflows: DITA XML, Markdown, reStructuredText, Git, and content automation scripts.",
      "url": "https://docs.redaction-technique.org/reference/example/",
      "markdown": "https://docs.redaction-technique.org/reference/example.md",
      "locale": "en",
      "wordCount": 47,
      "headings": [
        {
          "level": 2,
          "text": "Further reading",
          "slug": "further-reading"
        }
      ],
      "keywords": [],
      "tags": []
    }
  ]
}