使用reStructuredText Sphinx生成的HTML站点，在首页和每一页的侧边栏都会显示导航目录。问题是，默认的目录形式还不够高效 继续阅读“用sphinxcontrib-fulltoc为reStructuredText Sphinx扩展侧边栏目录”
利用统计代码对Web用户手册进行数据分析
用户手册要有足够的反馈才能更好地改进，直接去问最终用户的感受当然是最好了，不过这不太现实 继续阅读“利用统计代码对Web用户手册进行数据分析”
你有细看过“最终用户许可协议”么？
前一段时间我更新了一下公司产品的最终用户许可协议，发现这里头还是有很多学问的。 继续阅读“你有细看过“最终用户许可协议”么？”
技术布道与技术文档写作
前几天我的某位博客读者给我发了一封邮件，表示了一番感谢，因为他在看到我的某篇技术文章后，顺利解决了某个一直困扰他的问题。说真的，这事儿让我很开心，因为我感受到了技术布道的乐趣。 继续阅读“技术布道与技术文档写作”
2011年技术文档写作年终总结系列之四：内容组织技巧
前面已经陆续写了三篇技术文档写作总结系列了（1, 2, 3），貌似还没专门从用户手册的写作内容方面进行总结。本文就谈谈一些内容组织技巧吧。 继续阅读“2011年技术文档写作年终总结系列之四：内容组织技巧”
2011年技术文档写作年终总结系列之三：发布说明的维护
套用一句流行的话：曾经，我以为发布说明（release notes）是很不起眼的东西，直到我膝盖中了一箭。 继续阅读“2011年技术文档写作年终总结系列之三：发布说明的维护”
2011年技术文档写作年终总结系列之二：需求跟踪
软件产品开发的特点之一就是需求的变动是比较频繁的，特别是客户定制的产品。Technical writer若想要按时交付配套技术文档，就必须紧密跟踪需求的变动。 继续阅读“2011年技术文档写作年终总结系列之二：需求跟踪”
2011年技术文档写作年终总结系列之一：协作与反馈
目前公司包括我在内就两个人在负责技术文档的维护。虽然只有两个人，也是要讲究协作和反馈的。 继续阅读“2011年技术文档写作年终总结系列之一：协作与反馈”