iPhone應用文檔的良好做法

Question

我需要記錄一個相當複雜的應用程序。它至少有5個按鈕:)

所以當我寫了，我想知道別人如何寫他們的文檔/說明。

什麼應用程序（Word？Pages？TextEdit？有些特別？），什麼格式（pdf？big png？）。

你把超鏈接放在文檔中嗎？

你把文檔分解成塊還是它是一個大文件？

我希望能對此反饋意見。

在此先感謝您，如果這已被覆蓋了一百萬次，

Answer 1

如果你正在談論的應用程序的架構，考慮Doxygen

如果你有興趣在獲取用戶界面，你可以使用UML圖

編輯：你好@大衛，從您的評論，我可以看到你有興趣創建一個有效的指導手冊。好問題，因爲這是你產品的重要組成部分。

恕我直言，不能也不應該是一個通用的解決方案。例如，如果您試圖吸引網絡用戶，那麼使用帶有5-10個屏幕截圖的「入門」html頁面就足夠了。應用程序中的演練也被稱爲減少進入壁壘。另一方面，如果該應用程序是您的數學學生的圖形計算器，那麼他們將完美地在家中使用多頁.ps。

我的觀點是，您應該在考慮客戶的情況下創建說明手冊 - 他們實際花費多少時間閱讀說明。格式 - pdf（講義），doc，html（網絡）將取決於您的用戶可以訪問哪些媒體/格式。