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

发布于 2024-07-07 08:22:26 字数 1560 浏览 11 评论 0原文

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

城歌 2024-07-14 08:22:26

这个链接有一些优点。 每个观点都以清晰的语言和内在的理由提出。

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

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

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

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

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

  • 首页(封面页)
  • 封面和标题页
  • 免责声明
  • 前言
  • 内容
  • 指南正文
  • 程序
  • 编写程序
  • 分块文本
  • 为您的步骤编号
  • 使用“如果-那么”方法 参考资料
  • 术语
  • 返回事项
  • 索引
  • 建立标准
  • 文档格式
  • 结构风格
  • 技术语言
  • 向用户致意
  • 介绍您的材料
  • 特殊要求

This link has some strong points. Each point is presented with clear speech and with inline justifications.

When writing procedures, use the
active voice (e.g. Click this) and
address users directly (write "you"
rather than "the user").

When explaining an action, use the
"command" form of the verb:

"Choose an option from the menu and
press [ENTER]."

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

Here is the complete list of the topics covered on the aforementioned article:

  • Front Page (cover pages)
  • Cover and Title Page
  • Disclaimer
  • Preface
  • Contents
  • Body of the guide
  • Procedures
  • Writing procedures
  • Chunking text
  • Number your steps
  • Using the If-Then Approach
  • Reference Materials
  • Back Matter
  • Glossary
  • Index
  • Establishing Standards
  • Document Format
  • Structure Style
  • Technical Language
  • Addressing the User
  • Presenting your material
  • Special Requirements
不疑不惑不回忆 2024-07-14 08:22:26

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

DocBook 使用 XML 标记模式,让您思考应该如何排列文档。 有 XSL 转换可以将其转换为常见格式,例如 HTML 和 PDF,并带有大量配置选项,使其看起来像您想要的那样。 而且它是开源的(免费)。 当然也有缺点:模式相当大,如果没有好的 XML 编辑器,编辑工作可能会很困难。

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

For structure and look+feel, consider using a framework such as DocBook.

DocBook uses an XML markup schema that makes you think about how your document should be arranged. There are XSL transformations to convert it to common formats like HTML and PDF with a whole load of config options to make it look the way you want. And it's open-source (free). There are downsides of course: the schema's pretty big, and editing can be hard work without a good XML editor.

Examples: http://wiki.docbook.org/topic/WhoUsesDocBook

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文