Archive for the ‘2013 December’ Category

如何写技术文档

2013年12月12日

偶尔看到一篇有趣的文章,诙谐地描述了技术文档的写作过程。

我相信在实际工作中并非都是这样的,但这确实是有可能出现的情况:由于程序员太忙、不重视、认为 TW 应该具备和程序员一样的技术水平等各种原因,造成 TW 很难获取撰写技术文档所需要的信息。

这时候 TW 应该如何应对,相信大家各有各的方法。

曾经有人建议过一个方法: 在无法获得信息的情况下,先尽自己的努力快速完成初稿,虽然写出来的东西可能连自己都看不下去,但重要的是先把初稿完成并发出去,之后就在被工程师不断鄙视的 Review 过程中,获得有用的信息,最终按时完成项目。

这是不是一个好方法,我不加评论。还是放松一下心情,看看下面的文章吧。

...

Technical Writers, 请好好准备我们的个人简历吧!

2013年12月2日

由于近来公司部门在招聘技术文档工程师 (Technical Writer),也看了不少想要入行或是想要换工作的候选人的简历,觉得有必要聊聊 Technical Writer 的简历问题。

个人简历,是用人单位了解候选人非常重要的途径之一。是否可以获得面试的机会,可以说很大程度上取决于我们的个人简历能否在第一时间打动招聘官。简历的好坏,对于在面试官心中建立怎样的第一印象起着至关重要的作用。

对于我们技术文档工程师来说,个人简历就更为重要了。这是因为简历本身就是你的写作作品,你的简历反映了你的写作能力和工作态度。如果连这么重要的简历,都能出现拼写和语法错误,或者是让人觉得敷衍了事,那么这就很难让人相信你会是一个合格的技术文档工程师了。

...