寻找可以帮助我为软件应用程序编写用户指南的资源链接。我正在寻找一些东西来帮助我构建我的指南,给它一个合适的写作风格,并确保它始终具有良好的外观和感觉。
发布于 2008-10-20 12:37:54
这个链接有一些优点。每一点都以清晰的语言和内联的理由呈现出来。
在编写程序时,使用主动语态(例如,Click
),并直接称呼用户(写“”而不是"the user")。
在解释动作时,使用动词的"command“形式:
“从菜单中选择一个选项,然后按ENTER键。”
http://www.klariti.com/technical-writing/User-Guides-Tutorial.shtml
以下是上述文章中涉及的主题的完整列表:
首页(封面页)和封面和标题Page
material
发布于 2008-10-20 17:08:56
对于structure和look+feel,可以考虑使用诸如DocBook之类的框架。
DocBook使用了一种XML标记模式,它让您考虑应该如何排列文档。可以通过XSL转换将其转换为HTML和PDF等常见格式,并提供大量的配置选项,使其看起来符合您的要求。而且它是开源的(免费)。当然,也有缺点:模式非常大,如果没有一个好的XML编辑器,编辑工作可能会很困难。
示例:http://wiki.docbook.org/topic/WhoUsesDocBook
https://stackoverflow.com/questions/218261
复制相似问题