§ Documentation

Read the manual, eat your own dog food.

This documentation site is itself authored in Codex-IETM, using the Basic standard with a DITA overlay. Every page is a topic; every link is a conref.

Getting started

  • Quickstart in 5 minutes
  • Choosing a standard
  • Importing existing content

Authoring

  • Editor overview
  • Cross-references & reuse
  • Media & illustrations

Publishing

  • Render targets
  • Custom domains & SSL
  • Search indexing

Standards reference

  • S1000D BREX rules
  • DITA constraints
  • JSG profiles
  • Basic schema

Sample · Topic source

<topic id="hyd-system-desc">
  <title>Hydraulic system — Description</title>
  <prolog>
    <metadata>
      <category>maintenance</category>
      <audience type="technician" job="line"/>
    </metadata>
  </prolog>
  <body>
    <p>The hydraulic system supplies pressure to the
       primary flight controls...</p>
    <fig>
      <image href="img/hyd-overview.svg" alt="Schematic"/>
    </fig>
  </body>
</topic>