iPhone应用文档的良好做法

Question

我需要记录一个相当复杂的应用程序。它至少有5个按钮:)

所以当我写了，我想知道别人如何写他们的文档/说明。

什么应用程序（Word？Pages？TextEdit？有些特别？），什么格式（pdf？big png？）。

你把超链接放在文档中吗？

你把文档分解成块还是它是一个大文件？

我希望能对此反馈意见。

在此先感谢您，如果这已被覆盖了一百万次，

Answer 1

如果你正在谈论的应用程序的架构，考虑Doxygen

如果你有兴趣在获取用户界面，你可以使用UML图

编辑：你好@大卫，从您的评论，我可以看到你有兴趣创建一个有效的指导手册。好问题，因为这是你产品的重要组成部分。

恕我直言，不能也不应该是一个通用的解决方案。例如，如果您试图吸引网络用户，那么使用带有5-10个屏幕截图的“入门”html页面就足够了。应用程序中的演练也被称为减少进入壁垒。另一方面，如果该应用程序是您的数学学生的图形计算器，那么他们将完美地在家中使用多页.ps。

我的观点是，您应该在考虑客户的情况下创建说明手册 - 他们实际花费多少时间阅读说明。格式 - pdf（讲义），doc，html（网络）将取决于您的用户可以访问哪些媒体/格式。