coding-style - 我在哪里可以找到一个好的软件应用程序用户指南模板？

Question

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

score 2 · Accepted Answer

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

编写程序时，使用主动语态（例如单击此）并直接称呼用户（写“你”而不是“用户”）。

解释动作时，使用动词的“命令”形式：

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

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

score 0 · Accepted Answer

对于结构和外观，请考虑使用 DocBook 等框架。

DocBook 使用 XML 标记模式，让您考虑应该如何排列文档。有 XSL 转换可将其转换为 HTML 和 PDF 等常见格式，并带有大量配置选项，使其看起来像您想要的那样。它是开源的（免费）。当然也有缺点：模式非常大，如果没有好的 XML 编辑器，编辑可能会很困难。

2 回答 2