2012-08-06 32 views
0

我已經編寫了一些適度複雜的命令行可視化工具,並希望通過爲他們提供出色的文檔來增加他們的採用。編寫用戶手冊的示例和指南

我有不謙虛地說,工具是他們的目的很厲害,我想鼓勵讀者兩國都明白和掌握這個權力。

問題是,我真的不知道如何編寫優秀的文檔。

我想社區:

1)幫我找到優秀的用戶手冊的例子該類(工具軟件;在總的一對夫婦打功能,但動力來自於將它們結合起來;我草案手動約需15-25頁,包括大量的圖片和說明一切,但我認爲它的結構很爛)

2)幫我解答問題:

  • 我應該寫一個大的人工或我應該寫一個單獨的快速入門指南,用戶手冊和r eference?
  • 應該手動完全情緒中性,側重於解釋,而不是廣告,或者是確定以嘗試吸引讀者的通道像看我們多能這一數據樣本中發現,想象中提取相同的見解,而不工具或者,例如,讚揚讚美awk並建議讀者瞭解它?
  • 我如何找到正確的細節程度?
  • 當給出的例子,我就應該總是用很簡單的人開始,或者是確定首先證明一個複雜的例子,顯示了工具的權力,但並沒有真正教你如何使用該工具?
  • 用戶爲了不同目的與文檔進行交互的一些常見模式是什麼?例如:
  • 我能想象有人開始在第一頁,閱讀一切變得好奇(或沒有)
  • 我能想象有人立即跳轉到「快速啓動」指南,開始是例子瑣碎但容易重現,並變得有趣(或不)
  • 我也可以想象有人只是跳,Ctrl + F'ing和看圖像,以獲得快速的感覺。
  • 如何一次優化所有這些交互模式?

回答

0

我會做的GUI不言自明。一個好的GUI並不需要文檔。現在,無論您通過GUI進行可視化的任何命令行信息都需要輕鬆訪問(即,如果讓用戶看到命令行的語法示例,可以在GUI上輕鬆找到)。

+1

該工具不具有GUI :)它不像gnuplot,但更專業。 – jkff 2012-08-12 18:35:54