文件編寫的標(biāo)準(zhǔn)格式(參考版)
2024-11-06 05:57本頁面
【正文】 。 ） V； “ 230V,具有177?？捎孟率霰硎痉椒ù妫? “ 230 （ 1177。因此，諸如 230V177。避免諸如“五 m”和“ 5 米”之類的組合； e） 不要使用非標(biāo)準(zhǔn)化的縮略語表示單位，例如“ ses”（代替秒的“ s”），“ mins”（代替分的“ min”）等等； f） 不應(yīng)使用諸如“ ppm”“ ppb”之類的縮略語。）、等等； c) 不 要將單位的符號和名稱混在一起使用。 c) 如果文檔中由于特殊需求要使用新的符號，必須與文檔標(biāo)準(zhǔn)的負(fù)責(zé)人協(xié)商得到批準(zhǔn)才能使用，并還要在用戶文檔的“前言”部分的“本手冊約定”或“各類標(biāo)志”中加入新符號的含義說明。見 以下 2 個使用圖標(biāo)的例子： 示例 1： 注意： a） 參數(shù)配置成功后保存配置（主界面的“數(shù)據(jù)操作”按鈕 “保存配置”按鈕）并重新啟動設(shè)備才能生效； b） 當(dāng)設(shè)備 IP 地址修改后，保存重啟設(shè)備后，還必須 GoView 主菜單“設(shè)備” “設(shè)備管理”中更新 IP 地址，控件才能重新與設(shè)備連接。 “注意”或“說明”段落的上方和下方分別要用實線分隔。 b) 文檔中使用的各種圖形圖標(biāo)約定如表 4，“注意”或“說明”的兩橫線之間內(nèi)容不得跨頁： 表 4 圖標(biāo)約定 圖標(biāo) 意 義 注意： 用于提醒用戶在操作中應(yīng)該注意的事項，這些事項有可能會引起系統(tǒng)出錯。 [Ctrl] + [C] “ +”表示同時按下鍵盤上的多個按鍵完成一個操作。 拖動 按住鼠標(biāo)的一個按鈕不放，移動鼠標(biāo)。 例如有如下命令行： tftp host {get | put} {sys | cfg} filename 其實際用法為： tftp get sys 表 2 鼠標(biāo)操作約定 格 式 意 義 單擊 快速按下并釋放鼠標(biāo)的一個按鈕。 【】 帶粗中括號“【】”表示操作頁面上的一個參數(shù)配置區(qū)或功能區(qū) { XX | XX } 為 CLI 命令行的表示格式之一，表示命令行中多選一的命令字，多個命令字在大括號“ {}”內(nèi)用豎線“ |”分隔?？蔀榫匦巍E圓形等形狀，顏色可根據(jù)需要設(shè)定，通常為藍(lán)色。如“文件 \新建 \文件夾”多級菜單表示“文件”菜單下的“新建”子菜單下的“文件夾”菜單項。 附錄 B (圖形符號的附錄 ) 使用符號規(guī)定 a) 文檔中的圖形界面、鼠標(biāo)操作、鍵盤操作的格式約定分別見表
公司管理相關(guān)推薦
鄂ICP備17016276號-1