2010-01-16 71 views
2

當我嘗試在我的博客中記錄我的服務器配置步驟時,它看起來沒有結構化。我需要一些標準佈局指南,面向howtos的東西,標題,步驟,某種wiki支持的文檔創建標準,可以強制執行或指導文檔佈局。尋找符合標準的文檔工具

是否有任何這樣的文檔標準伴隨着wiki工具集?

+1

您可能會對serverfault.com上的這類問題產生更多的牽引力,我曾想過。 – 2010-01-16 14:17:35

回答

2

給一個嘗試DocBook

+0

我認爲這需要一些學習,但它顯示了我想要的結構。我認爲從長遠來看,使用它的原則將會變得很好 – vfclists 2010-01-18 11:33:07

1

我讀符合標準的爲簡單的「組織」,或者,「明顯給讀者」。考慮通常組織user documentation的典型方式。您通常打算在3個不同的主要使用案例中打開文檔:

  1. 該系統是新的,並且您正試圖弄清楚發生了什麼。 (PDF文件,較長的文章)
  2. 您正在查找您忘記的東西的詳細信息。 (指向男性參考信息的索引)
  3. 您需要特定問題的幫助,而且您不完全確定此工具如何幫助您。 (食譜,常見問題)

我可能會嘗試複製一個特定的生態系統(Windows,Unix,蘋果),基於用戶最熟悉的。