我是一家中型公司的员工(约 300 名员工),该公司开发和制造一些医疗相关设备。对于我们的设备,我们需要编写各种手册(约 20 人参与其中,其中大多数人还有其他职责),这些手册通常长达 100 页。
目前,我们正在使用 Word 2010 进行此操作,但(不用说)这会导致各种问题和大量时间浪费,例如当我们需要在现有手册中添加或更改某些内容时(这种情况经常发生)。这是因为我们的手册包含大量图表、列表(我的意思是使用 Latex 中的 {itemize} 获得的内容)和分页符。此外,所有手册都包含目录列表,大多数手册都包含图表列表和表格列表。
因此,公司(更具体地说,我和我的同事在得到上级批准的情况下)正在寻找编写和修改手册的替代、更好的方法。由于手册的配置方式与我在上一段中指定的方式相同,我们认为(经过一些“试验”)LaTeX 应该更适合它们。当然,在典型的公司中实施 LaTeX 通常是徒劳的,因为其他员工会反对(更具体地说,不愿意学习)。但是,应该指出的是,我们的员工受教育程度高于平均水平,我敢说,上述 20 名员工中至少有 5 名已经有使用 LaTeX 的经验。
此外,我们没有实施 LaTeX 的时间表(或者根本就不需要实施),最重要的是,如果我们决定实施,我们会采取全面的方法。因为我相信你们中的一些人在这方面有一些经验,所以我想问你们一些问题。请注意,你不必回答所有问题,任何帮助(即使与问题无关)都会受到感谢。
问题如下:
您是否同意我的观点,即 LaTeX 是编写和修改手册的最佳选择之一?如果不同意,您建议使用什么替代方案?
由于所有手册的配置方式大致相同,我们认为一个模板(我的意思是序言)就足以涵盖所有内容。序言应该如何形成,因为它可能包含各种包?{document} 本身内部应该遵循哪些规则?当我们想要修改序言时应该采取什么方法?
对于目前的“实验”,我使用 TexStudio 和 MiKTeX 作为编译器。但如果我们想更广泛地实现 Latex,就需要更多地考虑应该使用哪个程序。您建议使用哪些程序?请注意以下事项:
a) 可能最重要的是如何确保所有用户拥有相同版本的各种软件包、相同版本的编译器等。避免同一文档在不同的计算机上显示不同内容非常重要。请注意,我们公司有集中的 IT 部门,并且我们在计算机上使用 Windows。
b) 如果文档的外观由于某些软件包的更新而发生变化,则问题会小一些,但在这种情况下,我们需要以某种方式注意到这一点。此外,如果在更新某些软件包后出现问题(例如,文档无法编译),最好有一个选项可以恢复到旧软件包。
c) 还要注意,手册是用多种语言编写的。这就是我使用 TexStudio 进行实验的原因,因为它有内置的语言检查工具。
- 在某些时候,我们需要在实施 LaTeX 之前做好准备并教育其他同事。你对此有什么建议?我想到了以下几点:
a) 由于实施 LaTeX 并非易事,我们可以分步实施。我的意思是,由于手册的类型不同(不同的人负责),我们可以先针对一种类型实施(作为某种实验),然后再更广泛地实施(也可以分步实施)。更具体地说,首先应该实施的手册类型是我提到的同事(+2 名其他员工)负责的类型。
b) 在实施之前,我当然会写一本专门使用 LaTeX 的手册。此外,我和我的同事还会为其他同事准备培训。请注意,我们公司的员工流动率很低。
- 此外,您还有什么其他建议可以让实施工作顺利进行并且得到我们同事的积极态度?
答案1
对于本网站的格式来说,这个问题有点开放,但我会尝试回答。
首先,您需要决定如何使用乳胶。
- 直接用 latex 语法创作?
- 以 XML 或 markdown 等结构化形式进行创作并编写脚本转换为乳胶,就像后端 PDF 生成一样?
两者各有利弊(我们在工作中使用 XML,尽管近年来我们已经停止从中生成 PDF 而只是分发 html 版本,该手册有 15000 个 html 页,打印出来会有几十万张 A4 纸大小,所以相当大)。
哪个 TeX 发行版,这可能是个人偏见,因为我已经使用 texlive(最初是 tetex,最初是 unix tex 发行版)超过 30 年了
- 特科利
- 米克泰克斯
- overleaf(texlive 作为托管服务)
texlive 一直是跨平台的,并且是迄今为止 Linux 和 Mac 上最常见的版本,miktex 多年来仅限于 Windows,近年来它也被移植到 Windows 和 Mac,所以如果在 Windows 上,实际上只需从这两个中选择你想要的任何一个,但如果寻找跨平台使用,我会选择 texlive。
您还可以考虑 Overleaf,作为托管服务,没有安装障碍,所有用户自然会获得相同的设置。对于免费版本,如果您想编写文件生成脚本而不是直接在 latex 中编写,这会有点不方便,但商业版本(我没有)允许与本地 git 存储库集成,因此您可以(我相信)相当轻松地将本地生成的文件与 overleaf 项目同步。
如果你正在向人们介绍乳胶,你需要一些教程参考,浏览这个网站不会有什么坏处,但更结构化的包括
我应该透露一下,我参与了第一个的设置(它有多种语言版本)。即使您在生产中不使用 Overleaf,Overleaf 也不错。
答案2
给你一些随机的想法。
版本控制
因为 .tex 是 ASCII 格式,所以它可以像源代码一样被 Git 处理。使用 Git 你可以
- 建立工作流程
- 放弃任何形式的颠覆
- 接收、检查和整合更新,由某些员工说
- 比较版本/更新的文件
- 定义和合并分支,例如用于试验
- ETC。
例如,查找 Preißel 和 Stachmann 编写的“Git”。似乎至少有一个较旧的英语版本。
工作流程和模块化
开始映射和识别相同或相似过程的模块,以涵盖创建、修改、维护、分发手册或“文档片段”的全部或大部分工作。
尝试识别基本场景,即从中获取某种手册或部件的不同标准方法。
Latex 学习曲线
如果你跟着介绍 Latex 的书籍学习,难度可能会很大。如果你愿意预先选择并展示所需内容,难度可能会适中。与 Word 相比,理解 Latex 还很困难。如果只是使用它(例如借助程序),那就没问题了。
输出格式
我同意 @Philo Latex 非常适合创建 .pdf。吸引我的是其统一的外观和感觉,这是学术出版物、期刊等所熟知的。
如果您的主要格式是 HTML,Latex 可能不是最佳选择。不过,有功能强大的转换功能可用且正在开发中。
问题 1:Latex 是最佳选择吗?(针对 pdf)
是的。因为它很灵活。
对于需要多个用户输入的较大文档,Word 不在讨论范围内。
以布局为导向的程序,例如 Framemaker 或 Scribus(免费),考虑放置框架,其中包含任何内容,就像您在报纸中所做的那样(1 页上有 10 个信息部分)。
我个人使用 Scrivener(写作工具)和 Texmaker(编辑器,用于启动编译)的组合。Scrivener 允许您以您想要的方式构造任何内容。因此,我有一个部分定义 Latex 必需品,并在运行文本中使用自定义宏。完成后,组装所有内容,复制到 Texmaker 并编译。// 但是,Scrivener 无法与 Git 很好地配合使用,因为您无法轻松比较相似的文件(如更新)。
Q2:模板
你的写作方式。//使用 \include 语句加载您需要的任何类型的文本部分(章节、表格、图形......)
但是,我建议逐步建立演示文件,基本上研究您的需求并尝试实现想法。最后,您应该得到 1 个或非常少的基本模板。(无论您是从中派生 \documentclass{},这需要相当多的工作,还是只是 \include 您找到的样式(即包和宏的组装),都并不重要。)
Q3:Texstudio等
再次强调,将项目视为代码编程将使事情变得更容易。您可以使用任何您想要的编辑器创建 .tex 文件:因此每个员工都可以使用他或她自己的 ASCII 编辑器,例如来自程序员世界的编辑器。
您可以通过 TexStudio 等 GUI 编译 .tex 文件,它实现了下一句。或者您可以从命令行(Windows)或终端(Linux 等)运行它,如果需要,也可以通过脚本运行它。
更重要的是一种通用的工作流程,即每个人都必须遵循的规则,以使事情顺利进行。这可以并且应该涵盖内容、要使用或要避免的 Latex 元素、来回传递文件(Git 等)等等。
Q3a:统一性 + Q3b:备份
最好与 IT 部门沟通。也许可以采用集中式解决方案(例如通过本地 Overleaf 安装,在 github 上查找,参见 David 的评论)。或者您可以通过程序/规则来确保这一点,手动或自动完成。但是,您不想破坏员工过去几天的脆弱工作(在这里 Git 可以再次成为你们所有人的朋友)。
Q4:推广与教育
一个或几个员工中寻找热情的支持者可能效果会很好。他们在开发、推广和日常工作中都会很有价值,例如,只是在工作中提供帮助(支持)。
Q5:心态积极,顺利转型
当我们感觉或意识到“他们没有听取我的意见,我的意见不被重视,我的需求不相关”时,我们的态度是消极的。
那么该如何改变呢?有几种方法,按效果从低到高的顺序排列。
A) 聆听。询问。交谈。理解。讨论。面对面,小组形式等等。(M. Gorbatchov 和其他人就是通过这种方式取得很大进展的。)
B)会议(好吧,那些不无聊的,令人兴奋的,见下文。)
C) 协助会议. 那些人,虽然不属于你的部门,却知道如何让声音最大的人保持沉默,让声音最小的人表达自己的观点。例如,可以通过钉板、群集卡片等工具看到这一点。(但这只是工具集,经验丰富的主持人会根据需要使用。)
D)一种趋势是使用巴坎普斯半天到一天。人们喜欢这种自由格式,但结果和实施可能不尽如人意。(那么 C 可能更好)
E)(无意作为广告)如果我们不会仍然处于大流行之中,除非有治愈方法,否则我们所有人都会面临长期的新冠疫情,你应该雇用我“Projekt vertero”(=我会改变)。这是一个为期 3 天的过程(没有电话!没有邮件!等等),有 3-12 人组成小组,代表所有(或大多数)关于该主题的冲突观点,如员工、管理层、销售人员等,无论谁是相关的。// 在第 3 天,这个小组提出了一个几乎所有人都预先接受的有机概念。然后这个小组可以跟上步伐。// 更多信息,德语,请访问http://www.ms-spo.de/?id=41以及那里给出的链接。(translate.google.com)
除此之外你应该考虑一下项目管理。主要有 3 所学校:PMP、GPM IPMA、Prince2。前两所学校往往是学术性的,其含义是“这里有所有你可以做的事情……做出选择”),而 Prince2 是一个复杂的适应性程序,它以实践的方式结合了从好项目和坏项目中吸取的经验教训:只管去做。它们有时都感觉像是一种负担……但我相信你很快就会看到并喜欢 Prince2 的所有好处。(在我看来,只需获取他们的手册即可,无需证书。ISBN 978-0-11-331533-8)
答案3
如果您想要生成非打印输出,LaTeX 不是一种很好的格式。对于带有图形、表格等的 pdf 输出,它很棒。我将 Flare 和 Framemaker 中的一本书(对于 InDesign 来说太复杂)移到了 LaTex 中。但如果您需要 ePub、HTML、Word 等输出,它就很差了。对于这种情况,Flare、Framemaker 或 Oxygen XML 要好得多。