☰

技术参考手册/用户指南的 LaTeX 模板？

tag-icon • tag-icon templates
技术参考手册/用户指南的 LaTeX 模板？

我希望使用 LaTeX 来满足我的技术文档需求（例如参考手册、用户指南等）。我可以使用您的模板快速入门，以避免被 LaTeX 世界所淹没……大量的包和控制序列。至少，我需要一个用于目录、图表、表格、索引、词汇表的模板。任何其他好东西也欢迎。

另外，有什么好的（免费）前端吗？我打算使用 Lyx，但不确定是否有更好的选择。

最后，有人有使用过 DITA 和 LaTeX 的经验吗？如果我理解正确的话，DITA 用于构建“可配置文档”，您可以将用 XML 编写的单个、独立编写的部分拼接在一起。如果这些部分是用 LaTeX 编写的，我想您可以将两者一起使用。

顺便说一句，技术文档是针对软件的。

答案1

您可能会发现雷夫曼一个很好的起点；它被设计成为技术参考手册的一体化软件包。

话虽如此，我使用回忆录我的技术手册。它非常可定制，许多人都发布过这样的定制，例如这些章节样式。我编写的最后一本手册使用了这些章节样式之一的稍微修改版本，以及稍微调整的页面样式，以便为手写和边注提供更大的边距。

这回忆录手册被广泛认为是一份非常值得一读的优秀文档，其中包含有关排版的一般有用信息，并且以易于阅读的方式定义了有用的术语。

答案2

我现在没有空文档可以放在这里，但可以从一篇文章开始

\documentclass[10pt,a4paper]{article}

然后包含一些包（人们在 LaTeX 中默认加载哪些包？）

\usepackage[utf8]{inputenc}
\usepackage[english]{babel}
\usepackage[english]{isodate}
\usepackage[parfill]{parskip}

然后包括一些表格。

\pagenumbering{Roman}
\tableofcontents
\newpage
\listoffigures
\newpage
\listoftables
\newpage
\pagenumbering{arabic}

然后你开始写...

/玩得开心

相关内容