【问题标题】:Where can I find a good template for a software application user guide? [closed]我在哪里可以找到一个好的软件应用程序用户指南模板? [关闭]
【发布时间】:2010-09-18 02:38:59
【问题描述】:

寻找可以帮助我编写软件应用程序用户指南的资源链接。我正在寻找可以帮助我构建指南的内容,为其提供适当的写作风格,并确保它始终具有出色的外观和感觉。

【问题讨论】:

  • 您的用户群的一些迹象可能会有所帮助。可能是任何人,还是他们可能是开发人员/技术人员?
  • 一些关于您正在编写的软件类型的指示会有所帮助。例如,如果您的软件类似于 Microsoft Word,那么建议用户指南模板会很容易。

标签: coding-style user-guide


【解决方案1】:

此链接有一些优点。每一点都有清晰的表述和内嵌的理由。

在编写程序时,使用 主动语态(例如单击此)和 直接联系用户(写“你” 而不是“用户”)。

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

“从菜单中选择一个选项,然后 按 [ENTER]。”

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

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

  • 首页(封面)
  • 封面和标题页
  • 免责声明
  • 前言
  • 内容
  • 指南正文
  • 程序
  • 编写程序
  • 分块文本
  • 为您的步数编号
  • 使用 If-Then 方法
  • 参考资料
  • 返回问题
  • 词汇表
  • 索引
  • 制定标准
  • 文档格式
  • 结构风格
  • 技术语言
  • 寻址用户
  • 展示您的材料
  • 特殊要求

【讨论】:

    【解决方案2】:

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

    docbook使用XML标记架构,使您考虑如何安排文档。有XSL转换将其转换为像HTML和PDF等通用格式,具有整个Config选项,使其看起来您想要的方式。它是开源的(免费)。当然有缺点:架构非常大,编辑可以很难工作,没有良好的XML编辑器。

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

    【讨论】:

      猜你喜欢
      • 2010-09-19
      • 2019-09-24
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2013-03-17
      • 2010-11-04
      • 1970-01-01
      • 2010-09-14
      相关资源
      最近更新 更多