在哪里可以找到软件应用程序用户指南的好模板?

时间:2008-10-20 12:32:55

标签: coding-style user-guide

寻找可帮助我编写软件应用程序用户指南的资源链接。我正在寻找能够帮助我构建指南的东西,给它一个合适的写作风格,并确保它始终具有出色的外观和感觉。

2 个答案:

答案 0 :(得分:2)

此链接有一些优点。每个点都有清晰的语音和内联理由。

  

编写程序时,请使用   主动语音(例如,点击此)和   直接对用户说(写“你”   而不是“用户”)。

     

在解释动作时,请使用   动词的“命令”形式:

     

“从菜单中选择一个选项   按[ENTER]。“

http://www.klariti.com/technical-writing/User-Guides-Tutorial.shtml

以下是上述文章所涵盖主题的完整列表:

  • 首页(封面)
  • 封面和标题页
  • 声明
  • 前言
  • 内容
  • 指南正文
  • 程序
  • 写作程序
  • 分组文字
  • 为您的步骤编号
  • 使用If-Then方法
  • 参考资料
  • Back Matter
  • 词汇表
  • 索引
  • 建立标准
  • 文件格式
  • 结构风格
  • 技术语言
  • 致使用户
  • 展示您的材料
  • 特殊要求

答案 1 :(得分:0)

对于结构和外观+感觉,请考虑使用DocBook等框架。

DocBook使用XML标记架构,让您考虑如何安排文档。有一些XSL转换可以将它转换为HTML和PDF等常见格式,并提供一整套配置选项,使其看起来像您想要的那样。它是开源的(免费)。当然还有缺点:架构非常大,如果没有好的XML编辑器,编辑就很难。

示例:http://wiki.docbook.org/topic/WhoUsesDocBook