求教个冷门的问题：像ST、TI这种公司几百页的单片机手册是怎么做出来的？

XIVN1987 · 发表于 2021-1-22 09:52:13

是Word编写然后转换成PDF吗？还是有其他更专业的软件？

pcwhy · 发表于 2021-1-22 10:02:27

我觉得更大概率是用Latex来做的，Latex出来的东西就会特别漂亮，而且也没有word那些几千年都解决不好的小毛病。

矩阵时间 · 发表于 2021-1-22 10:04:37

如果是用福昕，使用 Crtl + D，可以看到文档描述里头有创建工具。打开了一个 NXP 文档，是用 Acrobat Distiller 11.0 (Windows) 创建的，还有 Acrobat PDFMaker 11 for Word。

armok. · 发表于 2021-1-22 10:04:52

WORD排版限制很多。

苹果的illustrator，pagemaker等才是专业的排印刷软件。

三世执戟 · 发表于 2021-1-22 10:11:20

无问西东 · 发表于 2021-1-22 10:11:46

以前在某台系单片机原厂干过，我审核过部分章节，确实是原件用word。不过word都是分开的，一个文件只负责一个外设章节的介绍，最多不过几十页。

fengyunyu · 发表于 2021-1-22 10:20:24

word转pdf

Error.Dan · 发表于 2021-1-22 10:22:54

有请大火炉!!!

PS:开玩笑的,最终不过还是要人写的,排版什么的无非是几种版式固定以后往里塞数据,word本身不是专业的排版工具,只是加强了排版功能的文字处理软件,真正专业还得是LaTaX这种,当然对PDF来说Adobe家也是最专业的,做半导体的一般应该都不差这两个钱去买一套专业的PDF软件吧(斜眼看大火炉~

PPS:最近在搞公司内部的信息化,有啥可以在局域网内部署的Web文档管理平台软件推荐吗?就是可以上传office格式文件可以在线浏览编辑的那种~

lyping1987 · 发表于 2021-1-22 10:23:21

大篇幅的，Latex比较多。。但代码级编写，很累。而且资料太少了！之前用latex写了份50多页的说明书，质量是可以，但再来第二次也蛮累的，代码报错资料都不好找。。

latex是印刷行业和写论文的利器。

lyping1987 · 发表于 2021-1-22 10:25:18

Error.Dan 发表于 2021-1-22 10:22
有请大火炉!!!

PS:开玩笑的,最终不过还是要人写的,排版什么的无非是几种版式固定以后往里塞数据,word本身 ...

https://github.com/TruthHun/DocHub
一个GO开发者做的，类似百度文库。

lyping1987 · 发表于 2021-1-22 10:27:54

Error.Dan 发表于 2021-1-22 10:22
有请大火炉!!!

PS:开玩笑的,最终不过还是要人写的,排版什么的无非是几种版式固定以后往里塞数据,word本身 ...

另外还有一个BookStack，这个是用markdown文件写书的，做公司产品API类的不错。可以对外提供，可以用导出PDF，但PDF质量没法与latex比了，类似网页打印输出。

我最近想做过内部工具，基于BookStack，内部共享资料，但可能需要优化一下。

XIVN1987 · 发表于 2021-1-22 10:35:40

本帖最后由 XIVN1987 于 2021-1-22 10:37 编辑

lyping1987 发表于 2021-1-22 10:27
另外还有一个BookStack，这个是用markdown文件写书的，做公司产品API类的不错。可以对外提供，可以用导出 ...

Markdown的格式控制能力太弱了，，公司内部用还好，，要是生成手册给客户用，会被认为是皮包公司的

Z11 · 发表于 2021-1-22 10:37:12

Error.Dan 发表于 2021-1-22 10:22
有请大火炉!!!

PS:开玩笑的,最终不过还是要人写的,排版什么的无非是几种版式固定以后往里塞数据,word本身 ...

小公司可以用钉钉，大公司最好还是自己定制一套

lyping1987 · 发表于 2021-1-22 10:38:30

XIVN1987 发表于 2021-1-22 10:35
Markdown的格式控制能力太弱了，，公司内部用还好，，要是生成手册给客户用，会被认为是皮包公司的{:titt ...

TEX太老了，不知道为啥，这个技术没有很明显的技术更新。。感觉应用还是蛮多的。。

XIVN1987 · 发表于 2021-1-22 10:43:37

无问西东发表于 2021-1-22 10:11
以前在某台系单片机原厂干过，我审核过部分章节，确实是原件用word。不过word都是分开的，一个文件只负责一 ...

感谢回复，，

word编辑、然后转换成PDF，，这应该是普通人最先想到的做法了，，

不过感觉页数多了的话，word会不会比较麻烦？？比如在第一页新插入几行内容，，那后面几百页可能都要重新调整下才能做到对齐、美观，，想想都崩溃

分成多个word编辑最后合成PDF也有问题，，因为文档内可能有前后引用，，比如讲到UART，它的时钟使能位可能在SYS外设的某个寄存器，可能会做个超链接跳过去，，如果不在一个文件里，链接地址怎么确定？

bone · 发表于 2021-1-22 10:47:48

我们以前一家公司就是先做文档，当然文档是用openoffice做的，不熟悉的人完全看不懂。将所有数据填充进去之后，用脚本就能直接生成各种头文件，包括c和verilog的。
最后那些图表什么的还是需要专门安排人员设计的，大公司里人多，做起来就相对容易多了。

huangqi412 · 发表于 2021-1-22 10:48:05

估计网页方式再打印的也有吧。

hcambridge · 发表于 2021-1-22 11:03:46

XIVN1987 发表于 2021-1-22 10:43
感谢回复，，

word编辑、然后转换成PDF，，这应该是普通人最先想到的做法了，，

用word没问题的。
大公司都是有模板的，套用模板写就好了。
大文档里的标题，表头，任何带编号的东西都是用域做的，动态的索引，就像目录一样，写完了，F9更新一下，就全好了。
而且大公司有人专门负责处理文档格式的，格式检查可以用VbScrpit处理，分分钟整理好，这都不是事儿。

XIVN1987 · 发表于 2021-1-22 11:06:12

本帖最后由 XIVN1987 于 2021-1-22 11:07 编辑

armok. 发表于 2021-1-22 10:04
WORD排版限制很多。

苹果的illustrator，pagemaker等才是专业的排印刷软件。

感谢老大回复

工具很重要，，不过我觉得排版源格式可能更关键些，，比如markdown、reStructuredText、还有多位坛友提到的Latex

如果有靠谱的源格式，哪怕用不起专业的软件，，用vscode+插件这样的通用编辑器也可以写，，

现在已知的格式：
markdown格式控制能力太弱，，用来写github上项目的README还行，，写芯片手册太粗糙了
Latex格式控制能力超强，，用来写论文的，，不过我没用过，，不知道写起来怎么样
word是个所见即所得的软件，，不方便格式的批处理，，听说word的底层源格式是xml，，不过没听说有人直接编辑底层xml源文件的，，估计它的格式定义也没考虑过手动编辑

所以我就想看看有没有哪位坛友知道国外大公司是怎么做。。他们用的什么源格式

redroof · 发表于 2021-1-22 12:24:25

XIVN1987 发表于 2021-1-22 11:06
感谢老大回复

工具很重要，，不过我觉得排版源格式可能更关键些，，比如markdown、reStructuredText、 ...

科学论文，公式超多的，铁定latex，用word会疯掉。
公式不多的，随便用啥都行，latex图文混排的灵活程度不如word自由，而且强制必须先定义格式后使用，内容和格式强制分开，不像word可以随便对任何东西改格式。所以word写小东西更省事，不用学就能上手

dukelec · 发表于 2021-1-22 12:38:33

我的 cdbus 控制器 cdctl-bx 手冊就是用 LaTeX 寫的，平時簡單文件也會用 markdown 寫，用帶 markdown 插件的 chrome 打開並打印成 pdf。

對格式沒要求的用 libreoffice 寫 word 文檔，word 文檔最麻煩的是，一段話裡面有幾個字格式和周圍不同，又比較接近的話，不容易找出來，還有很多其它樣式的細微差異不好統一。
一般是對方發過來 word 文檔或者明確要求使用 word 才會用。反正用 word 的場合對細節要求不嚴格，隨便弄弄湊合就成。

rainbow · 发表于 2021-1-22 13:32:22

lyping1987 发表于 2021-1-22 10:38
TEX太老了，不知道为啥，这个技术没有很明显的技术更新。。感觉应用还是蛮多的。。 ...

看了一下Ti的，还真是iText。

Error.Dan · 发表于 2021-1-22 13:41:40

Z11 发表于 2021-1-22 10:37
小公司可以用钉钉，大公司最好还是自己定制一套

我已经在内部推腾讯文档用在一般办公场合了,当他们发现可以全公司所有人编辑统一个表格(比如马上过年回家的行程报备,团建签到)时,他们都惊呆了~

所以现在行政的同事和几个负责具体事务的领导用的很多,主要就是统计和收集一些不敏感的信息,之前还试图推一推一般性的办公文档做版本管理(也是腾讯文档内置了)但是似乎对普通人来说有点困难~

我现在就想找个能集成到一般企业OA里面的文档系统,可以上传文档,简单的在线编辑,可以把文档作为一些流程节点的输入或者输出.

钉钉在上家公司深度用过,我还开了公司的开发者账号写过一些企业内部应用(采购单导入啥的),最后的结论是除非完全的内部应用那么钉钉非常好,他自己的生态圈已经高度自洽了,有开发能力或者愿意花钱的完全可以基于钉钉搭一套非常完善而且定制化的企业信息化系统
但是我们考虑有些服务要暴露给外部客户的,那么钉钉就非常不合适,因为不是人人都有钉钉,但是现在人人有微信.

lyping1987 · 发表于 2021-1-22 15:43:24

rainbow 发表于 2021-1-22 13:32
看了一下Ti的，还真是iText。

iText好像更小众。。。。

modbus · 发表于 2021-1-22 15:49:17

我们公司几百页的PDF版使用手册就是用WORD做的

tuy0326 · 发表于 2021-1-22 15:51:30

LaTex 最佳，学习时间耗费不少，Word上手就能用，不过，排版能死人

modbus · 发表于 2021-1-22 15:53:12

XIVN1987 发表于 2021-1-22 10:43
感谢回复，，

word编辑、然后转换成PDF，，这应该是普通人最先想到的做法了，，

“比如在第一页新插入几行内容，，那后面几百页可能都要重新调整下才能做到对齐”，这个对WORD熟手来说不存在的，比如可以用段前分页等分页控制功能来避免

rainbow · 发表于 2021-1-22 20:09:05

lyping1987 发表于 2021-1-22 15:43
iText好像更小众。。。。

大概搜了一下，是个jar的脚本，要写代码的。

看来小公司还是老实用word算了。

cctv02 · 发表于 2021-1-22 21:49:29

看了下手册不知什么软件

lw32 · 发表于 2021-1-25 09:04:01

Error.Dan 发表于 2021-1-22 10:22
有请大火炉!!!

PS:开玩笑的,最终不过还是要人写的,排版什么的无非是几种版式固定以后往里塞数据,word本身 ...

群晖有office套件，支持多人同时编辑，文档、表格、PPT都有，功能比MS的差点，但基本功能都有

simplorer · 发表于 2021-1-25 12:34:18

本帖最后由 simplorer 于 2021-1-25 12:37 编辑

我曾经用过latex的变种ctex，格式化确实有独到之处，但是学习周期和成本太长了，最后放弃。
另外就算要用latex，也不要选ctex，这个软件目前基本没人维护了。

后来转到了adobe的专业排版软件framemaker。
格式设置这一块确实功能强大。

我曾经按照公司安排，比照ti的一款芯片文档，一比一翻译。
表格自己绘制，图片直接copy，主要是省事。

最终的中文pdf，自我感觉有原文档90%的相似度。

下面截取两个文档的图片，最后附上原文档。

-------修改：上传附件

求教个冷门的问题：像ST、TI这种公司几百页的单片机手册是怎么做出来的？

阿莫论坛20周年了！感谢大家的支持与爱护！！

本帖子中包含更多资源

本帖子中包含更多资源

本帖子中包含更多资源