系統(tǒng)與軟件工程 用戶文檔的設計者和開發(fā)者要求 現(xiàn)行
Systems and software engineering—Requirements for designers and developers of user documentation
標準號：GB/T 32424-2015
本標準規(guī)定了兩方面內(nèi)容:a) 過程標準,規(guī)定用戶文檔的編制過程;b) 文檔產(chǎn)品標準,規(guī)定對用戶文檔結(jié)構(gòu)和信息內(nèi)容的要求。本標準的第5章~第9章規(guī)定了用戶文檔設計者和開發(fā)者的文檔編制過程。包括:建立用戶需要的信息、確定信息呈現(xiàn)給用戶的方式、準備信息并使信息可用。這一過程不限于生存周期的設計與開發(fā)階段,還包括貫穿信息管理和文檔編制過程的活動。第10章和第11章規(guī)定了對用戶文檔的結(jié)構(gòu)和信息內(nèi)容的要求。適用于軟件系統(tǒng)用戶在工作環(huán)境中使用的印刷文檔和屏顯文檔,包括印刷的用戶手冊、在線幫助、教程和用戶參考文檔。附錄A 給出了適用于英文版本的用戶文檔的呈現(xiàn)格式,附錄B、附錄C、附錄D分別提供了用戶文檔檢查表、要求條款和文檔編制過程檢查表以及要求條款和文檔產(chǎn)品的檢查表。盡管本標準未覆蓋以下類型文檔的所有方面,但對于其開發(fā)可能有所幫助:a) 除軟件以外的產(chǎn)品的文檔;b) 使用了動畫、視頻、音頻的多媒體系統(tǒng);c) 基于計算機的培訓(CBT)包和正規(guī)的培訓大綱中使用的專業(yè)課程材料;d) 為安裝人員、計算機操作人員或系統(tǒng)管理員等制作而不是為最終用戶制作的文檔;e) 描述系統(tǒng)軟件內(nèi)部操作的維護文檔;f) 并入用戶界面的文檔。本標準適用于文檔的設計者和開發(fā)者,包括多種專家:a) 對文檔產(chǎn)品在文檔集中的結(jié)構(gòu)和格式進行規(guī)劃的信息設計師和架構(gòu)師;b) 確定預期用戶將用軟件執(zhí)行的任務的易用性專家和商業(yè)分析師;c) 開發(fā)和編輯用戶文檔書面內(nèi)容的人員;d) 具備電子媒體專業(yè)知識的平面設計師;e) 共同設計文檔在屏幕上的呈現(xiàn)形式的用戶界面設計師和人類工效學專家。本標準還可供文檔編制過程中的其他角色和利益相關(guān)方查閱:a) 軟件開發(fā)過程或文檔編制過程的管理人員;b) 閱讀由供方編制的文檔的需方;c) 易用性測試人員、文檔評審人員和領(lǐng)域?qū)＜?d) 屏顯文檔創(chuàng)建工具的開發(fā)者;e) 確定原則使文檔更易于理解和易于使用的人為因素專家。
|
本標準按照GB/T1.1—2009給出的規(guī)則起草。 本標準使用重新起草法修改采用ISO/IEC26514:2008《系統(tǒng)與軟件工程用戶文檔的設計者和開發(fā)者要求》(英文版)。 本標準與ISO/IEC26514:2008的技術(shù)性差異如下: ———將ISO/IEC26514:2008的第12章移至附錄A,作為資料性附錄。 ———刪除了ISO/IEC26514:2008的附錄A、附錄B和附錄C。 ———刪除了ISO/IEC26514:2008的附錄D。 ———刪除了ISO/IEC26514:2008正文部分有關(guān)英語語言習慣的內(nèi)容及格式的要求及相關(guān)示例。 請注意本文件的某些內(nèi)容可能涉及專利。本文件的發(fā)布機構(gòu)不承擔識別這些專利的責任。 本標準由全國信息技術(shù)標準化技術(shù)委員會(SAC/TC28)提出并歸口。 本標準起草單位:國家網(wǎng)絡軟件產(chǎn)品質(zhì)量監(jiān)督檢驗中心(濟南)、中國電子技術(shù)標準化研究院、廣州廣軟信息系統(tǒng)管理咨詢有限公司、上海計算機軟件技術(shù)開發(fā)中心。 本標準主要起草人:楊福濤、黃姍姍、孟憲勇、張彬、張雪莉、袁肅蓉、劉新、蔡立志、劉振宇、胡蕓。 |
| 前言 Ⅲ 引言 Ⅳ 1 范圍 1 2 符合性 1 2.1 概述 1 2.2 符合性的應用 2 2.3 符合性場景 2 3 規(guī)范性引用文件 2 4 術(shù)語和定義 2 5 系統(tǒng)/軟件生存周期中的用戶文檔編制過程 7 6 項目的需求、目標和約束條件 9 6.1 概述 9 6.2 項目目標 9 6.3 用戶文檔要求和約束 10 6.4 項目的目標和約束條件 11 6.5 用戶和易用性目標 12 6.6 訪談技術(shù)聯(lián)絡人和其他專家 13 6.7 項目策劃 13 6.8 文檔建議書 16 7 分析和設計 17 7.1 概述 17 7.2 受眾和任務分析 17 7.3 用戶文檔設計 21 8 開發(fā)與評審 22 8.1 概述 22 8.2 文檔原型和草稿 22 8.3 文檔的評價 24 8.4 文檔測試 27 9 制作 28 9.1 概述 28 9.2 最終的合編和評審 28 9.3 批準 29 9.4 配置管理 29 9.5 更新和維護 29 10 文檔結(jié)構(gòu) 29 10.1 概述 29 10.2 文檔的整體結(jié)構(gòu) 30 10.3 取決于受眾需求的文檔結(jié)構(gòu) 31 10.4 屏顯文檔的主題的大小 32 10.5 用戶文檔的部件 32 10.6 用戶文檔部件的布局 33 11 用戶文檔的信息內(nèi)容 34 11.1 概述 34 11.2 信息的完備性 34 11.3 信息的準確性 34 11.4 標識數(shù)據(jù)的內(nèi)容 34 11.5 文檔使用的信息 35 11.6 操作概念 35 11.7 軟件一般使用的信息 36 11.8 規(guī)程和教程的信息 37 11.9 關(guān)于軟件指令的信息 38 11.10 數(shù)據(jù)輸入域的解釋 39 11.11 錯誤消息和問題解決方案的內(nèi)容 39 11.12 警告和注意事項的內(nèi)容 40 11.13 術(shù)語信息 40 11.14 相關(guān)信息來源的信息 41 11.15 用戶提供的內(nèi)容 41 附錄A (資料性附錄) 文檔的呈現(xiàn)格式 43 附錄B(資料性附錄) 用戶文檔檢查表 66 附錄C (資料性附錄) 文檔編制過程的要求條款和檢查表 71 附錄D (資料性附錄) 文檔產(chǎn)品的要求條款和檢查表 74 參考文獻 78 |
暫未檢測到相關(guān)機構(gòu)，邀您申請入駐~
暫未檢測到相關(guān)機構(gòu)，邀您申請入駐~
暫未檢測到相關(guān)機構(gòu)，邀您申請入駐~
? 2018 北京寰標偉業(yè)科技發(fā)展有限公司版權(quán)所有并保留所有權(quán)利。
ICP備案證書號：京ICP備17031081號-1 客服電話：010-62050868
