使用reStructuredText Sphinx生成的HTML站点，在首页和每一页的侧边栏都会显示导航目录。问题是，默认的目录形式还不够高效 继续阅读“用sphinxcontrib-fulltoc为reStructuredText Sphinx扩展侧边栏目录”
reStructuredText Sphinx HTML中文搜索解决方案
默认情况下，reStructuredText Sphinx生成的HTML站点对中文搜索支持非常有限，基本上那个搜索框就是个摆设而已。Google一下，发现早就有高手 继续阅读“reStructuredText Sphinx HTML中文搜索解决方案”
利用统计代码对Web用户手册进行数据分析
用户手册要有足够的反馈才能更好地改进，直接去问最终用户的感受当然是最好了，不过这不太现实 继续阅读“利用统计代码对Web用户手册进行数据分析”
技术布道与技术文档写作
前几天我的某位博客读者给我发了一封邮件，表示了一番感谢，因为他在看到我的某篇技术文章后，顺利解决了某个一直困扰他的问题。说真的，这事儿让我很开心，因为我感受到了技术布道的乐趣。 继续阅读“技术布道与技术文档写作”
魔鬼在于细节
Technical writer在写用户手册时容易出现的问题就是，想当然地以为某个功能或者说操作步骤是显而易见、无需过多描述的，可有时候往往这些细节对用户而言才是关键所在。 继续阅读“魔鬼在于细节”
Docbook PDF格式输出效果增强实例
Docbook的PDF格式输出流程相对HTML而言，是比较复杂的。CSS运用熟练的话，HTML格式输出的效果可以做得很漂亮；不过PDF格式就没那么多选项可供操作了。本文以Docbook常见的emphasis标签为例，介绍如何增强PDF格式输出的效果。 继续阅读“Docbook PDF格式输出效果增强实例”
开源简繁转换工具OpenCC在技术文档写作中的批处理应用
中文简繁转换是个值得研究的课题。如果只是偶尔有一两篇长度为几千字的文档需要转换，直接用微软Offce Word 自带的简繁转换功能就行了，最多再花点时间人工校对下。但是，在规模较大的技术文档写作任务中，用Offce Word的话显然效率很低，得另寻他法。 继续阅读“开源简繁转换工具OpenCC在技术文档写作中的批处理应用”
Sphinx reStructuredText中文PDF输出解决方案之rst2pdf
以前尝试用rst2pdf将Sphinx reStructuredText文档输出为PDF时总是报错，即便是用不含中文的文档也没成功过。rst2pdf其实是个不太完美的作品，其作者甚至说过他一度想要放弃这个项目了（见这里）。 继续阅读“Sphinx reStructuredText中文PDF输出解决方案之rst2pdf”
也谈中文的简繁转换
最近手头上的任务不多，没事时我就检查了一遍公司产品的繁体版UI界面，发现了一些以前没注意到的细节问题，主要是关于简繁转换的。 继续阅读“也谈中文的简繁转换”
2011年技术文档写作年终总结系列之四：内容组织技巧
前面已经陆续写了三篇技术文档写作总结系列了（1, 2, 3），貌似还没专门从用户手册的写作内容方面进行总结。本文就谈谈一些内容组织技巧吧。 继续阅读“2011年技术文档写作年终总结系列之四：内容组织技巧”