DebianWiki:WikiPolicy
出自DebianWiki
目錄 |
[編輯] Wiki 寫作規範
[編輯] 著作範圍
DebianWiki 主要提供 Debian 系統相關的資訊，如系統安裝介紹，軟體介紹，中文化應用，以 自由軟體 為主，但不限制其他電腦應用資訊或自由軟體社群的著作，介紹與收集。
[編輯] 著作授權
請注意！任何對 DebianWiki 的任何貢獻都將被認為是在 GNU 自由文件許可證 下發布。 (細節請見 DebianWiki:Copyrights)，如果您不希望您的文字被任意修改和再散布，請不要提交。您同時也向我們保證您所提交的內容是您自己所作，或得自一個不受版權保護或相似自由的來源。 不要在未獲授權的情況下發表文件！
若您發現任何可能侵犯著作權的文件內容，請將可疑的內容與線索，如來源網站，報章雜誌等情報資訊，張貼於該頁面的聊天頁。如文件內容侵犯您的著作權，請即刻與管理者聯絡，我們會盡速移除侵權文件。
[編輯] 命名規範
- 請祇加上要開始填寫內容的連結，要開始寫了才加連結。
- 請勿使用 Category 頭字語作為分類。
- 請勿使用中文頁名。
- 一來是網址會變成肉眼無法解析的 URL，二來是悲苦的 Microsoft Internet Explorer 常常搞錯編碼方式，會連不上來。
- 頁名若為數字，首字請大寫，每字字首大寫。 Wiki 會自動加入空白。
- 頁名請以駝峰字表示（例如: WikiPage) 而非空白分隔表示。
[編輯] 文體規範
- 原則上以正體中文為主。
- 請以白話文撰寫。
- 請勿使用內嵌注音符號之注音文。
- 若引用地方性方言，或次文化，如青少年流行次文化專用語或黑客專業術語，請盡可能敘述說明。
[編輯] 軟體與程式指令範例寫作範例
[編輯] 內容介紹
基本上，內容是 What、When、Why、hoW
- What - 指令名稱、包含於何種軟體，簡要功能說明。
- When - 何時使用這個指令或軟體來解決何種問題
- Why - 為甚麼使用這種工具而非其他軟體。
- hoW - 如何使用。
範例: procps
建議每個指令以分裝的計畫名稱來區別。例如 ps 屬於 procps，但 procps 又包含 /sbin/sysctl、/bin/kill、/bin/ps、/usr/bin/uptime、/usr/bin/tload、 /usr/bin/free、/usr/bin/top、/usr/bin/vmstat、/usr/bin/watch、 /usr/bin/skill、/usr/bin/pmap、/usr/bin/pgrep、/usr/bin/w.procps、 /usr/bin/pkill、/usr/bin/snice 等。以計畫作為分類，各項指令才不至於混亂。例如以 rlogin 而言，實作的就有 netkit (rsh-client) 以及 Rsh-redone(rsh-redone-client)，實作不同，用法便略有差異，這是需要特別注意的。
[編輯] 範例設計
接下來討論範例的設計，原則上範例以愈明顯易懂愈佳。簡而言之，就是 KISS。Keep It Simple Stupid。
每個指令的範例著重於該指令的基本用法與用途，因此盡可能不與其他指令相搭配較妥。
而範例的例子應該以實際示範較易懂。目前的 wiki 頁面中許多範例像是
cat FileName
對於生手，許多虛設參數反而另人困惑，照打指令卻出現
cat: FileName: No such file or directory
或許可改以類似
cat /etc/passwd
等範例，生手只需照打，而不至於出現錯誤訊息，還傻呼呼來問，為甚麼會有錯誤訊息。此外，範例中如果要讀取特定系統檔案或使用特定指令，應該以 base system 存在的檔案或程式為標的，盡量不使用生手可能未安裝的軟體。範例說明應詳細敘述目前假設的環境為何。(如 IP, gateway 等參數)
預設使用的 shell 應以普遍使用的 "bash" 為基本。範例中如果使用 shell script，應明確指明使用的 shell 名稱。避免使用 #!/bin/sh ，由於某些系統可能將 /bin/sh 以其他如 csh/tcsh 取代。
#!/bin/bash echo "Hello World"
系統 locale 應該設置為 "C"，標準語系，而不以簡體或繁體中文。避免因為翻譯上的誤差造成疑惑。
LC_ALL=C export LC_ALL
範例中，如無必要使用 root，便盡量少用。如 apt-cache serach 便無須 root 權限。
apt-cache search apt
為顯示目前使用的帳號與權限，必須指定 shell prompt 以明顯區分差別。應該以統一的 hostname 與 username 為標準。 如標準用戶
user@debian:~$ PS1='user@debian:\w\$ ' user@debian:~$ cd /tmp user@debian:/tmp$ pwd /tmp user@debian:/tmp$
超級用戶(root)
debian:~# export PS1='debian:\w# ' debian:~# cd /etc debian:/etc# pwd /etc debian:/etc#
範例中如果有特殊名詞，如 loopback、root ，則以新頁面說明。
範例必須以 <pre></pre> 函括。
[編輯] 政治與宗教立場
本站採中庸態度，無論兩岸統一或台灣獨立無論陳水扁或連戰當選，一律歡迎使用本系統。
本站也對 vim/emacs 或套件系統採取中立角色。無論使用 RedHat 或Mandrake 或 Slackware 或 Gentoo 或 FreeBSD 或其他各種本文未提到的作業系統與軟體套件系統，一律為使用者個人偏好。
由於本站同時提供給可以閱讀正體中文的朋友參與著作，因此內文可能使用各種地方性用語，或特定的詞句，如『口令』『密碼』『光盤』『光碟』等。有容乃大，請放寬胸懷接納大家的異質性。
請勿在此挑起口水戰或發起民族性的激情論述。
![[Main Page]](/upload/4/49/Debian_taiwan_out.png)