Welcome to InfoDev Uni. This is a practical learning space for technical writers who want to go beyond documentation and understand the technologies behind it.

This is not theory-heavy. The goal is simple:
Learn just enough to work confidently with developers, tools, and modern documentation systems.

Languages

These are the core languages every modern technical writer should be comfortable with.

Markdown

Markdown is the most widely used writing format in developer ecosystems.

Why it matters:

  • Used in GitHub, docs-as-code, README files
  • Simple syntax, easy to learn
  • Converts easily to HTML, PDF, and other formats

What to learn:

  • Headings, lists, tables
  • Code blocks
  • Links and images

Practice: Write your own README for a project.

HTML

HTML is the backbone of all web documentation.

Why it matters:

  • Helps you debug formatting issues
  • Required for advanced customization

What to learn:

  • Basic tags: div, span, a, img
  • Structure: header, body, sections
  • Semantic HTML

Practice: Inspect any website and try to understand its structure.

AsciiDoc

AsciiDoc is used in enterprise documentation.

Why it matters:

  • More powerful than Markdown
  • Used in tools like Antora

What to learn:

  • Attributes
  • Includes
  • Admonitions (notes, warnings)

XML

XML is still widely used in structured documentation.

Why it matters:

  • Required for DITA
  • Used in legacy systems

What to learn:

  • Tags and attributes
  • Schema and validation
  • Well-formed vs valid XML

ReStructuredText (ReST)

Used in Python documentation ecosystems.

Why it matters:

  • Used with Sphinx
  • Common in open-source projects

What to learn:

  • Directives
  • Roles
  • Table formatting

YAML

YAML is used for configuration.

Why it matters:

  • Used in Jekyll, CI/CD pipelines, APIs
  • Controls how systems behave

What to learn:

  • Indentation rules
  • Key-value structure
  • Lists and nesting

Go (Golang)

You don’t need to master it, just understand basics.

Why it matters:

  • Many modern tools are built in Go
  • Helps in reading CLI tool logic

What to learn:

  • Basic syntax
  • Functions
  • Structs

SQL

SQL helps you work with data.

Why it matters:

  • Useful for analytics documentation
  • Helps understand backend systems

What to learn:

  • SELECT queries
  • JOINs
  • Filtering and aggregation

Python

Python is the most useful scripting language for technical writers.

Why it matters:

  • Automate documentation tasks
  • Work with APIs and data

What to learn:

  • Basics: variables, loops, functions
  • File handling
  • API calls

JavaScript (JS)

Useful for modern documentation sites.

Why it matters:

  • Used in interactive docs
  • Needed for frontend-heavy docs

What to learn:

  • Basics: variables, functions
  • DOM manipulation
  • JSON handling

Concepts

These are core frameworks and approaches every technical writer should understand.

DITA (Darwin Information Typing Architecture)

DITA is a structured documentation standard.

Why it matters:

  • Used in large enterprises
  • Enables content reuse and scalability

Key ideas:

  • Topics (concept, task, reference)
  • Maps for structure
  • Reusability using conrefs

Diátaxis Framework

Diátaxis is a modern documentation framework that helps you structure content based on user needs.

Core idea: Not all documentation is the same. Users need different types of information at different times.

The 4 Types of Documentation

1. Tutorials (Learning-oriented)

  • Step-by-step guidance
  • For beginners
  • Focus on doing, not explaining everything

Example:
“Build your first API request”

2. How-to Guides (Task-oriented)

  • Solve a specific problem
  • Assume some prior knowledge

Example:
“How to deploy your app on AWS”

3. Reference (Information-oriented)

  • Straight facts
  • No storytelling

Example:
API documentation, parameter lists

4. Explanation (Understanding-oriented)

  • Deep understanding
  • Why things work the way they do

Example:
“How REST APIs work internally”

Why Diátaxis matters

Most bad documentation mixes everything:

  • Tutorials become explanations
  • References become guides

Diátaxis fixes that by keeping content focused.

How to apply it in your work

When writing anything, ask:

  • Is the user learning?
  • Is the user solving a problem?
  • Is the user looking for facts?
  • Is the user trying to understand?

Then choose the right format.

How to Use InfoDev Uni

  • Pick one language at a time
  • Practice with real examples
  • Build small projects (docs, APIs, guides)
  • Apply Diátaxis to everything you write

Final Thought

A modern technical writer is not just a writer.

You are:

  • A translator between humans and systems
  • A systems thinker
  • A product enabler

InfoDev Uni is your foundation to become that.