[Tex/LaTex] Technical documentation class

document-classesdocumentation

I just made a component that is going to be added to our platform in the next month.
As such I need tu draw out some documentation for the guys that will do the integration.

Is there any class that allows me to quickly produce technical documentation or do I need do engineer it myself?

Best Answer

The hitec document class is designed for use for technical documentation. It is based on the standard article class, but was designed to have a very different look. There are a MWE here.

Related Solutions

[Tex/LaTex] a good Manual/Guide class in LaTeX

Do consider Texinfo, as endorsed by Karl Berry for this task. The Latex-based compilation route is pretty bare bones, but it allows you to produce custom html, and supporting hint boxes in the html is not too difficult. pandoc is a serviceable Latex to Texinfo converter.

A Latex example, the source of Oetiker's Not so short introduction to LaTeX2e is available: he uses the normal book class, together with a custom style, and supports some graphically offset hints, although I think not really what you are after. See lshort.tex and lshort.sty.

Context was designed with producing educational books in mind, and is good for putting together documents with boxed content for emphasis, and allows some use of interactive PDFs and XML-based publishing. The introductory text, Context: An Excursion, showcases this.

[Tex/LaTex] How to document the style files

The standard is the DTX format where you put the documentation as comments around your code. Normally in the comment all code is wrapped in macrocode environments and macros again in macro environment. It is then compiled using the ltxdoc class which uses the doc package.

See more information about DTX at the TeX FAQ: https://texfaq.org/FAQ-dtx

Example:

% \begin{macro}{\mymacro}
% Some explanation
%   \begin{macrocode}
\def\mymacro#1#2{%
  \relax
  \dosomething
%   \end{macrocode}
% Explain the next part of the macro
%   \begin{macrocode}
  \domore
  \expandafter\some\code
}
%   \end{macrocode}
% \end{macro

Note that you can autogenerate a DTX file from any package or other code file using the sty2dtx script.

Best Answer

Related Solutions

[Tex/LaTex] a good Manual/Guide class in LaTeX

[Tex/LaTex] How to document the style files

Example:

Related Question