Documentation

如何編寫手冊頁?

  • March 13, 2015

如何編寫手冊頁?

在哪裡可以找到所有格式程式碼的參考?

有沒有關於編寫手冊頁的好教程?

編寫手冊頁最方便的方法是什麼?我應該直接在文本編輯器中輸入嗎?有所見即所得的編輯器嗎?或者我應該以不同的格式編寫它然後轉換?

一個好的手冊頁應該遵循什麼規則?

以下是一些可以幫助您入門的網頁:

幾個有用的工具:

有一些用於編寫繞過 troff 格式的手冊頁的工具。聯機幫助頁是一種小型、良好分隔的語言,並且易於定位。

兩個流行的工具是:

yodlzoem似乎是這個領域中其他不錯的格式。

總而言之,我推薦 xmltoman,因為它是一個非常特定於聯機幫助頁的 dsl,它將密切指導您。

引用自:https://serverfault.com/questions/109490