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

Coding style 在哪里可以找到一个好的软件应用程序用户指南模板?,coding-style,user-guide,Coding Style,User Guide,正在查找指向资源的链接,这些资源将帮助我编写软件应用程序的用户指南。我想要的东西将帮助我构建我的指南,给它一个适当的写作风格,并确保它有一个良好的外观和感觉贯穿始终 这个链接有一些优点。每一点都有清晰的语言和内联的理由 编写过程时,请使用 主动语音(如单击此)和 直接称呼用户(写“你” 而不是“用户”) 解释动作时,请使用 动词的“命令”形式: “从菜单中选择一个选项,然后 按[输入]。” 以下是上述文章涵盖的主题的完整列表: 头版(封面) 封面和标题页 免责声明 序言 内容 指南正文 程序

正在查找指向资源的链接,这些资源将帮助我编写软件应用程序的用户指南。我想要的东西将帮助我构建我的指南,给它一个适当的写作风格,并确保它有一个良好的外观和感觉贯穿始终

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

编写过程时,请使用 主动语音(如单击此)和 直接称呼用户(写“你” 而不是“用户”)

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

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

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

  • 头版(封面)
  • 封面和标题页
  • 免责声明
  • 序言
  • 内容
  • 指南正文
  • 程序
  • 写作程序
  • 分块文本
  • 给你的步骤编号
  • 使用If-Then方法
  • 参考资料
  • 背景
  • 词汇表
  • 索引
  • 建立标准
  • 文件格式
  • 结构样式
  • 技术语言
  • 寻址用户
  • 展示你的材料
  • 特殊要求

结构和外观+感觉,考虑使用一个框架,如DoBook. DocBook使用XML标记模式,让您思考文档应该如何排列。有XSL转换将其转换为HTML和PDF等常见格式,并使用大量配置选项使其看起来符合您的需要。而且它是开源的(免费的)。当然也有缺点:模式相当大,如果没有好的XML编辑器,编辑工作可能会很辛苦


示例:

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