LaTeX for Tech Docs


If you need to use LaTeX to create technical docunmentation, here are some examples and instructions that will help you. Surprisingly, in my experience quite a few Tech Doc departments are still using LaTeX or they are considering using it as an option. It isn't as easy to use as say Jekyll or Hugo using markdown, and it is limited in its output, usually PDF. But if you need to take on the challenge of producing high-quality user guides or manuals using LaTeX, it can be done - and done very well. My goal with this section is to share with you my painful experiences with it so you don't have to go through the same.


1.1 About LaTeX

Published 08 March 2020 | Posted under latex

LaTeX comes "out-of-the-box well prepared to produce high-quality product documentation.

1.3 LaTeX quickstart

Published 30 April 2020 | Posted under latex

Use this quickstart to learn how to use LaTeX to build a sample document

1.4 Structure of a sample LaTeX file

Published 30 April 2020 | Posted under latex

Let's now take a closer look at the structure of a very simple LaTeX file, the classic Hello World file.

2.0 LaTeX skeleton structure

Published 30 April 2020 | Posted under latex

This is the LaTeX skeleton file that I found on StackExchange that got me started learning how to develop high quality LaTeX based product documentation.

3.2 Selecting the Document Class

Published 29 March 2020 | Posted under latex

The documentclass command tells the LaTeX typesetter how to handle the document and which document package to use to typeset the output.

3.3 Using Input or Include Commands

Published 12 April 2020 | Posted under latex

In a root file, referencing chapter file can be done using either the include or the input commands.

3.5 Inserting images

Published 30 April 2020 | Posted under latex

You define in the stylesheet how images appear in the document.

4.0 Creating LaTeX Stylesheets

Published 14 April 2020 | Posted under latex

Use a stylesheet to easily maintain all the styles used by your LaTeX project.

4.6 Defining and Using Colours

Published 23 April 2020 | Posted under latex

By setting colour definitions in the stylesheet, you can reference them throughout the stylesheet or in the document.

5.0 Creating custom tables

Published 24 April 2020 | Posted under latex

You can add simple to complex tables to a LaTeX document using several types of packages, depending on the requirements of the table.

6.0 Formatting chapter sections

Published 29 April 2020 | Posted under latex

Chapters in LaTeX require specific commands and use section headings which are pulled out into the Table of Contents.

6.1 Formatting text

Published 29 April 2020 | Posted under latex

Latext provides commands for formating text, creating lists and adding images.

6.2 Inserting code snippets

Published 30 April 2020 | Posted under latex

Here is some syntax you can use to insert code snippets and code highlighting in a text flow.