DokuWiki

It's better when it's simple

使用者工具

網站工具


側欄

這份翻譯較原始頁面舊,可能已過時。 檢視變更
本頁之翻譯?:

Learn about DokuWiki

Advanced Use

Corporate Use

Our Community


Follow us on Facebook, Twitter and other social networks.

Our Privacy Policy

zh-tw:tips:good_style

良好寫作風格的建議

以下建議,可幫助你撰寫優質維基頁面的。

頁面結構

  • 頁面以一級標題作起始,起一個意義明瞭的題目。
  • 按正確順序嵌套標題級別。第二級的內容應該以一個二級標題開始。
  • 段落之間用空行隔開。平均而言,一個段落不應該長於10-20行。
  • 如果您的內容長於3-5段,考慮用二級到五級的標題把它分成幾個章節。
  • 若您的內容長於2-3個屏幕頁時,在這個頁面的第一個標題下放一個簡短的摘要。當您的內容特別長的時候,考慮把它分成多個維基頁。
  • 如果您有很多到其他維基頁或者到外部資源的連結,應該添加一個「參考」的章節。
  • 如果同一個分類名稱(namespace)下的很多頁面都有一個相同的頁面結構,添加一個這個分類名稱的模板,這樣任何新的頁面都能用這個框架開始撰寫。
  • 盡量避免過於複雜的分類名稱結構。盡量使用簡短、好記的空間分類命名。

文字格式

  • 粗體或者斜體強調單個詞語或者較短的文字段。二者選一,不要換來換去交替使用。
  • 對於屏幕的輸出,以及諸如選單標籤或按鈕等等的文字,選擇某種風格樣式來展現,且應一致地使用它。為你的 wiki 增加一個風格樣式規約的說明頁,或許是個不錯的主意。
  • 對於相互獨立的敘述使用無序列表(unordered list)。如果您在描述一個思維過程,應該把它們寫成一個由語句構成的連續的文字段。
  • 不要過於頻繁的使用註腳(footnotes),即使要用它,也只是一些簡短的補充說明。如果對於某個話題有很多要說,把它放在一個新的維基頁面裏。如果您參考其他的(或者外部的)訊息源,使用連結(links)。
  • 表格可以極大的提升結構化數據的可讀性。如果您插入了一個表格,確保它有意義明確的單元格名稱和一個能清晰描述表格內容的標題(例如,“表格1.2: 行星間的平均距離”)。
  • 大的表格會很不好修改。考慮用嵌套列表來表示。

語言

  • 書寫沒有語病的句子,並且在必要的時候為名詞添加冠詞。
  • 以大寫字母開始句子,並且以句號或者其他合適的標點結束。
  • 盡量書寫簡短、清晰的句子,不要使用太多的從句。當您覺得寫完一個維基頁面的時候,從頭再讀一遍並且修改那些結構過於複雜的句子。
  • 判斷如何稱呼您的讀者。由於DokuWiki主要用於書寫文檔,您會經常需要指導您的讀者如何去做某些事情。您可以使用命令形式(“這樣做!”),我們/您形式(“然後,我們/您點擊…”),或者的形式(“接下來把 foo 加到 bar,使用…”)。不要混合使用這些形式。
  • 在保存之前,檢查您頁面的語法錯誤和錯別字。如果您有許多錯別字,不論您如何把閣下的肺腑(廢苦)之言大書特書,都會拉低可信度。
  • 發展出您自己的寫作風格。不要強迫您自己用自己不習慣的風格寫作。這樣只會聽起來不自然,讀起來也不舒服。

參考引用

  • 當您有一個需要更多解釋的術語時,給這個術語添加一個新的維基頁面,並且連結它。
  • 在完成之前重新檢查,並且對您的頁面中的核心術語(central terms),添加連結到已有的維基頁面中。
  • 不要在某術語的每個出現處都添加連結。在第一次或者最顯著的出現位置添加連結,而且也許在「參考引用」這一章節添加一個連結。
  • 提供到圖片來源、數據來源、引用來源的連結。
  • 不妨在您的維基頁面結尾添加一行「另見:」(See also:)。提供一些和您當前頁面題目關係密切的維基頁面的連結
  • 若您要提供外部資源的指針(pointers),而該資源在您的主題中有更多額外的訊息,或該資源您用以撰寫維基頁面,可在維基頁面結尾加上「參考引用」(References) 或「更多資訊」(Further information)的段落,並提供連結或其他指針(例如:ISBN 國際標準書號)。若你尚未完成正文,請對參考引用的意圖加以說明。
  • 設定interwiki連結的捷徑(shortcuts)能有助於連至常用的資源。

圖片和其他媒體

  • 「一圖勝千言。」它甚至可能意味著比你想說的更多1) 相較於語言的可靠性,人們傾向於較少質疑圖片的可靠性。一段簡短的文字敍述,優於一個不準確的圖片。
  • 當伴隨表格時,總要為圖片加上說明,這將表達出您以此圖片所要表現的意思。
  • 若這圖片不是您所創建的,表明其來源(盡可能使用連結)和版權。
  • 除非是在明確的允許之下,否則不要從外部網站連接使用圖片。首先這不只是個版權的問題,當外部圖片緩存關閉時,更會是個頻寬盜用的問題。
  • 若該圖片約大於三分之一的屏幕頁面,使用帶有修改尺寸的連結,去插入縮略圖。
1)
而且,您不能以圖片表達這個引用,你能嗎?
zh-tw/tips/good_style.txt · 上一次變更: 2015-12-31 14:57 由 YosephW