加载中…
博文
标签:

it

分类: UX设计
UX设计对企业级应用也是必需的

User eXperience (UX) 设计通过改善产品的可用性,易用性,以及用户与产品交互过程中的用户体验,来达到提升用户满意度的目的。随着互联网的触角伸向世界的每个角落,终端用户有机会去接触各种不同的软件,并且能够自由地做出选择。这时,软件的用户体验变得异常重要,它在很大程度上决定了用户是否会选择这个软件。

互联网的世界正在发生翻天覆地的变化,与此
阅读  ┆ 评论  ┆ 转载 ┆ 收藏 
(2013-05-11 12:38)
分类: UX设计
近来由于工作需要研究了一点User Interface (UI) 设计方面的东西。在国内UI设计还是一个比较新的领域,前景也不错。而作为Technical WriterTechnical Communicator,同样需要从用户角度看产品,了解UI设计的基本原则或者做些UI
阅读  ┆ 评论  ┆ 转载 ┆ 收藏 
分类: 技术写作概论

在小公司当一名技术写作者其实是一件有挑战的工作。除了要有专业技能,还需要有多方面的能力。在我的经验中,尤其要做到以下几点:

 

  1.  把自己培养成为一名多面手
  2.  学会自己做决策
阅读  ┆ 评论  ┆ 转载 ┆ 收藏 
标签:

杂谈

分类: DITA
读完《DITA Best Practices》,确有相见恨晚的感觉。建议在转换到DITA之前通读一下此书,可以少走些弯路。在此把文中重点内容做个总结。在实践过程中应时刻提醒自己:DITA的宗旨在于提高内容的可读性(易懂,易用,易检索),同时方便进行文档的写作和管理。

阅读  ┆ 评论  ┆ 转载 ┆ 收藏 
(2012-10-27 16:49)
分类: 项目管理

  近期的一个项目是把一些遗留内容从docbook转成DITADarwin Information Typing Architec

阅读  ┆ 评论  ┆ 转载 ┆ 收藏 

关键词:项目文件夹,资源,关键时间点,时间倒推法,甘特图

 

项目管理并非项目经理一人的职责,参与开发项目者人人有责。对于同时投身于多个产品和项目的TC(Technical Communicator),尤其需要运用一些项管的方法来提高工作效率。

当你接到一个写作任务,需要做哪些管理工作呢?

 

建立项目文件夹

Leah老师特别强调了一个项目需要一个物理文件夹(而不只是电脑上的虚拟文件夹),原因是很多琐事不能及时输入电脑,需要记在本子上。文件夹把一个项目的东西集中起来,方便查看。

项目资料包括关键角色(Project Manager、Subject-Matter Expert、Technical Communicator、评审参与者等),目标读者的相关信息,对文档的要求,开发项目的计划,会议纪要,头脑风暴结果,一闪而过的灵感,等等。凡是与该

阅读  ┆ 评论  ┆ 转载 ┆ 收藏 
(2012-05-14 07:28)

去年结束了STC(Society for Technical Communication)的TechComm101课程,今年参加了TechComm201课程。大概是因为亚洲区人数不够,照例按照美国时间开课。于是每次都少不了和睡神博斗一番,错过了Leah老师的一些金玉良言。好在Handout内容详尽,凭逻辑和记忆大致能推导一二,赶紧趁热打铁记下来。难免有遗漏谬误之处,望同行多多指正。

TechComm101主要介绍Technical Communication领域一些基本概念和基本方法,而201更加深入地探讨了一些重要命题,并且加入了项目管理的内容。

1. 文档项目管理

2. 编辑写作工具的使用

3. 写作风格

4. 国际化与本地化

5. 帮助(Help)相关的基本概念

6. 编辑与校对

在后面的博文里我会逐个进行详细说明。需要注意的是,理论不是生产力,能实践的理论才能转化为生产力。所以需要看官仔细鉴别这些方法是否适用

阅读  ┆ 评论  ┆ 转载 ┆ 收藏 

我们常常听到对用户手册的一个抱怨是,“内容太多了,就是找不到需要的”。遗憾的是,作者在内容方面做了很多工作,却因为编排不到位,无法满足读者需求。Developing Quality Technical Information一书提出高质量的技术文档需要做到易用、易懂、易检索(easy to use, easy to understand, easy to find)。易检索就是指读者能够方便地找到想看的内容。

这是我总结的一些提高手册易检索性的方法:

1、 整个手册的内容结构清晰,布局合理,章节按一定逻辑排列。

2、不同性质的内容要分开,用明显的标记列出。例如,描述、步骤、参考等。特别要标注出一些需要引起读者注意的内容(如警示、注意、提示等)。

3、 引用手册中别处的内容时要准确,最好用交叉链接。

4、 章节标题要简洁,能准确概括内容。

5、不要忽略索引。索引是一项重要工作。读者通常首先在目录中找内容,找不到就会到索引中找。(具体见

阅读  ┆ 评论  ┆ 转载 ┆ 收藏 
标签:

杂谈

分类: 技术写作概论

字体作为文档格式的一种属性,与文章的内容并无直接关系,但它会影响读者对文档的第一印象以及文档的可读性。每种字体都有它公认的特性(personality),选好字体对于整个文档的质量也有不可忽视的作用。

 

几种主要的英文字体

 

在技术文档中常出现的英文字体包括:

 

字体

特征

显示

serif

有衬线

 

阅读  ┆ 评论  ┆ 转载 ┆ 收藏 
标签:

stc

技术写作

it

分类: 技术写作概论
以下是我对这些法则和解读:

1.Paper is permanent. 写下来的东西会一直存在。设想某一天你翻看以前写的文档,看到一个个低级错误蹦出来,你不禁面红耳赤:写的时候怎么就没发现呢?!要杜绝这些低级错误,不仅要对词语拼写、语法、句法、标点烂熟于心,还需熟悉所使用的写作规范。可以利用工具作为辅助手段:拼写检查工具、编辑辅助工具,甚至将写作规范的某些内容设置成写作工具中的格式规则来执行。另外还需要作者反复校对修改。Writing is about rewriting. 反复锤炼才能得精品。
2.Know your audience. 只有熟悉了目标读者,才能奠定文档基调。试问以下问题:读者主要从事哪些职业?担当哪些角色?专业水平如何?期望从本文档中得到哪些信息?从每个读者群中抽取一个典型的读者样本,建立其基本信息 (persona),如system administrator。
3.Make hazards stand out. 将告警信息(如“危险”、“警告”、“注意”等内容)与正文分开,并放在适当的位置,如操作步骤之前。
阅读  ┆ 评论  ┆ 转载 ┆ 收藏 
Welcome!

Heading to Atlantis
Struggling all the way,
On this lonely road.
Not to heaven it leads,
But to the Atlantis.

个人简介
孤单的技术传播者(Technical Communicator)。希望能找到更多同行,共同探讨职业发展之道。
LinkedIn:
http://cn.linkedin.com/pub/yuanyuan-lai/28/99/171
QQ:
23899191
搜博主文章
评论
加载中…
留言
加载中…
访客
加载中…
  

新浪BLOG意见反馈留言板 电话:4006900000 提示音后按1键(按当地市话标准计费) 欢迎批评指正

新浪简介 | About Sina | 广告服务 | 联系我们 | 招聘信息 | 网站律师 | SINA English | 会员注册 | 产品答疑

新浪公司 版权所有