前几天我的某位博客读者给我发了一封邮件,表示了一番感谢,因为他在看到我的某篇技术文章后,顺利解决了某个一直困扰他的问题。说真的,这事儿让我很开心,因为我感受到了技术布道的乐趣。 继续阅读“技术布道与技术文档写作”
魔鬼在于细节
Technical writer在写用户手册时容易出现的问题就是,想当然地以为某个功能或者说操作步骤是显而易见、无需过多描述的,可有时候往往这些细节对用户而言才是关键所在。 继续阅读“魔鬼在于细节”
2011年技术文档写作年终总结系列之三:发布说明的维护
套用一句流行的话:曾经,我以为发布说明(release notes)是很不起眼的东西,直到我膝盖中了一箭。 继续阅读“2011年技术文档写作年终总结系列之三:发布说明的维护”
2011年技术文档写作年终总结系列之二:需求跟踪
软件产品开发的特点之一就是需求的变动是比较频繁的,特别是客户定制的产品。Technical writer若想要按时交付配套技术文档,就必须紧密跟踪需求的变动。 继续阅读“2011年技术文档写作年终总结系列之二:需求跟踪”
2011年技术文档写作年终总结系列之一:协作与反馈
目前公司包括我在内就两个人在负责技术文档的维护。虽然只有两个人,也是要讲究协作和反馈的。 继续阅读“2011年技术文档写作年终总结系列之一:协作与反馈”