Skip to content
Redaction-technique.org
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Select language
English
Français
✍ Blog — redaction-technique.org
Technical writing: An industrial process
Technical writing: an industrial process
CMS: workflow as a bonus, but reliability to be tested
Content creation
Delivery
Gathering information
Git: from file to content
Integrating documentation into development processes
Project definition
Repository
Shared network directories - unsuitable for group work
A single repository?
Source format
SQL database
Target format
Testing products to document them
Translation
Using branches in source management systems
Validation and quality control
Version management systems - rustic but reliable
Which repository for group work?
Technology watch
Technology Watch
Automatically insert data into a reStructuredText file
Automatically insert SQL data into a reStructuredText file
Create different documents from the same sources using Jinja
Create different documents from the same sources via Jinja (object method)
Create different documents from the same ReST sources (conditional text)
DITA XML and XSL-FO tutorials
Managing a project from start to finish
Regular expressions in Python
The Raspberry Pi 3 as a documentation platform
sed: modify your text without opening your files
Shuffling words
Structured DITA XML format
Structured DITA XML format
Case studies in using DITA XML
A document architecture that's too complex?
From document to modular document base
Case study: NuFirewall documentation
Structured and unstructured formats
Reduce costs, increase customer satisfaction
Technical documentation: reduce costs, improve customer satisfaction
From technical writing to technical communication
Formats and tools
Is an index useful in a PDF?
KISS Principle of Simplicity
The three levels of technical documentation
Select theme
Dark
Light
Auto
Select language
English
Français
Delivery
By
Olivier Carrère
Animations published on streaming sites
Brochures distributed at trade shows or provided to customers by sales engineers
Newsletters sent to customers
Updated website content
Documents posted online as PDFs or distributed as printed guides
Related articles
Section titled “Related articles”
Validation and quality control
Target format
Project definition