美文网首页技术文档写作
How to Apply Topic-Based Writing

How to Apply Topic-Based Writing

作者: Joy的未来十年 | 来源:发表于2017-12-01 15:18 被阅读28次

最近在研究竞对的手册,看到了华为的《FusionInsight软件安装手册》,这本手册言之有物,组织合理,考虑周全。在写作上方法上,是典型的topic-based writing的安装手册。

在上一节中,我谈到在写《安装手册》时,我找到了让自我满意的写作方式--基于实例完成写作,但在全文组织上,仍是沿用linear的方式来串起每个步骤(即在每个task里都加入了呈前启后的段落,让用户明白当前操作在整个workflow中的位置),严格上讲还不是task-based writing。我对Idratherbewriting搏主Tom所说的Task-based documentation is the best approach to suit impatient doers who want to do a task--是否适用于《安装手册》存有怀疑。看到华为的这本,我觉得这就是一本可以借鉴的基于task-based writing写作的安装手册。通过这份手册,我也对如何进一步完善task-based方法用于《安装手册》写作,有了更深入的想法---“呈前启后”的信息必不可少,可将它们包装进task中,在task中加入“操作前提”,“后续操作”tag。

手册结构

image.png
image.png

Task的基本元素

在Task中通过前提条件元素起到承前启后的作用。

image.png

建议

最后,我为这本手册提点锦上添花的建议:用1,2,3步骤来串起这些子操作索引。


image.png

相关文章

网友评论

  • Joy的未来十年:Digest from D.Q.T.I:
    Task
    Provides procedural details, such as step-by-step instructions, along
    with information such as /rationale/, /prerequisites/, and /examples/. For
    example, a topic called “Changing authorizations” is a task topic and
    might contain a /brief overview/ of changing authorizations, a list of /prerequisites/,
    /steps/ to change the authorizations, and a list of any /follow-on (postrequisite) tasks/.

本文标题:How to Apply Topic-Based Writing

本文链接:https://www.haomeiwen.com/subject/qvrdbxtx.html