Skip to content

Olivier CarrèreTechnical writing practice

Expertise
About
Professional profile

LinkedIn GitHub

Select theme

Select language

Start here
1. Understand documentation
2. Build a documentation process
3. Adopt docs-as-code
4. Choose an authoring model
- Overview
- Structured authoring
  - Use structured authoring
  - Structured and unstructured formats
  - YAML DITA topics
    Overview & schema
    Task: Replace blade
    Concept: Information typing
    Reference: Blade specifications
  - DITA XML in Astro
    Overview & pipeline
    Concept: Lawnmower
    Task: Changing the oil
    Reference: Plug-in config
- DITA
- From document to modular document base
- Source vs target formats
5. Build your toolkit
6. Automation & legacy techniques
Explore the reference
Documentation API & AI
- Documentation API
- Ask the documentation
Professional profile ↗

Expertise
About
Professional profile

LinkedIn GitHub

Select theme

Select language

4. Choose an authoring model
Structured authoring
DITA XML in Astro
Concept: Lawnmower

Lawnmower

Conceptlawnmowerconcepten-us

The lawnmower is a machine used to cut grass in the yard.

Lawnmowers can be electric, gas-powered, or manual.

Beginning of sequence

Next →Changing the OilTask

DITA Map: DITA Structured Authoring Demonstration MapStep 1 of 3

1. Lawnmower Concept
2. Changing the Oil
3. Plug-in Configuration Reference

DITA XML provenance

Source :DITA Open Toolkit (dita-ot/dita-ot)

Commit :6166605b05 (src/main/samples/concepts/lawnmower.xml)

DTD grammar :-//OASIS//DTD DITA Concept//EN

Copyright and license :IBM Corporation (Copyright 2001, 2005. All Rights Reserved.)

License status:DITA-OT dual-license at user election (Common Public License v1.0 or Apache Software Foundation License v2.0)

Raw .dita source Raw .xml source Raw .ditamap source

RELATED

Overview & pipeline

Task: Changing the oil