Engineering Design Doc

LetXUpdated MIT
Open full PDF

 

About this template

An engineering design doc in Lato with context and scope, goals and non-goals, architecture, the API contract, data model, migration plan, observability and a launch checklist.

Tags

tech-docslatex
Preview

What is in this template

Read from the source files of this template.

Document class
article [11pt, a4paper]
Compiles with
pdfLaTeX
Pages in the compiled PDF
8
Bibliography
None
Files
15 files: 14 .tex, 1 image
Packages
  • geometry
  • fontenc
  • inputenc
  • lato
  • inconsolata
  • amsmath
  • amssymb
  • xcolor
  • setspace
  • fancyhdr
  • titlesec
  • tabularx
  • booktabs
  • array
  • multirow
  • enumitem
  • tcolorbox
  • listings
  • fontawesome5
  • hyperref
  • microtype
  • graphicx
The preamble of main.tex, from \documentclass to \begin{document}.
\documentclass[11pt, a4paper]{article}

% Packages and styling live in preamble.tex; each section has its own file under
% sections/. Edit those directly --- this file is the outline of the document.
\input{preamble}

% Lets TeX stretch interword space on a line it cannot otherwise break, instead of
% running past the margin. Affects only lines that would overflow.
\setlength{\emergencystretch}{3em}

Put this template on your own page

Open in LetX

Paste this badge on a thesis guide, a course page or a README. One click opens the template as a new project in the reader's own LetX account.

Markdown
[![Open in LetX](https://letx.app/badges/open-in-letx.svg)](https://letx.app/open?template=engineering-design-doc)
HTML
<a href="https://letx.app/open?template=engineering-design-doc"><img src="https://letx.app/badges/open-in-letx.svg" alt="Open in LetX"></a>
About the Open in LetX badge

Frequently asked questions

What does the Engineering Design Doc template load?

It uses the article class (options: 11pt, a4paper), builds with pdfLaTeX, and loads 22 packages, including geometry, fontenc, inputenc, lato, inconsolata, amsmath, amssymb and xcolor.

How long is the Engineering Design Doc sample?

The compiled sample is 8 pages, from 15 files: 14 .tex, 1 image. Replace the sample text with yours and the layout stays.

Is the Engineering Design Doc template free to use online?

Yes. "Open as Template" makes it your own LetX project: edit the LaTeX in the browser, invite collaborators to edit with you in real time, and download the compiled PDF. There is nothing to install.

Working out which one you need?

More Technical Docs templates

\begin{now}

Start writing with Engineering Design Doc, free, in your browser, with real-time collaboration.