Member-only story

Writing Smarter: How LTex and Diátaxis Can Improve Your Technical Documentation

Gijs Reijn
9 min readMar 17, 2024

--

Unsplash

Ever wondered how you can structure and improve your writing style in technical documentation, whether it is publicly, or privately?

Lately, I’ve really gotten the feeling into writing — articles, blogs, and technical documentation for projects on my work.

The thing that always got to me, was a way of thinking about documentation and styling in general.

I love to keep things as simple and understandable as possible, especially if you’re not writing only for yourself.

That’s when starting out a project, or actually creating the initial setup inside a repository to store technical documentation, I want to follow a certain standard and have checks available to me that show me any incorrectness in the documentation.

Because most of my documentation is written in Markup Languages, I learned about spelling checkers, linters, and lately, LTeX and Diátaxis framework.

If you’re also writing technical documentation in Markup Languages (who doesn’t these days?), then read on to learn about LTeX and the Diátaxis framework.

Introduction to LTeX Extension and Diátaxis Framework

--

--

Gijs Reijn
Gijs Reijn

Written by Gijs Reijn

Sharing my experience through the IT world. Tutorials, guides, and opinions. Follow my newsletter at: http://eepurl.com/i1hSUw

Responses (1)