本標準規(guī)定了兩方面內(nèi)容:
a) 過程標準,規(guī)定用戶文檔的編制過程;
b) 文檔產(chǎn)品標準,規(guī)定對用戶文檔結(jié)構(gòu)和信息內(nèi)容的要求。
本標準的第5章~第9章規(guī)定了用戶文檔設(shè)計者和開發(fā)者的文檔編制過程。包括:建立用戶需要的信息、確定信息呈現(xiàn)給用戶的方式、準備信息并使信息可用。這一過程不限于生存周期的設(shè)計與開發(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) 基于計算機的培訓(xùn)(CBT)包和正規(guī)的培訓(xùn)大綱中使用的專業(yè)課程材料;
d) 為安裝人員、計算機操作人員或系統(tǒng)管理員等制作而不是為最終用戶制作的文檔;
e) 描述系統(tǒng)軟件內(nèi)部操作的維護文檔;
f) 并入用戶界面的文檔。
本標準適用于文檔的設(shè)計者和開發(fā)者,包括多種專家:
a) 對文檔產(chǎn)品在文檔集中的結(jié)構(gòu)和格式進行規(guī)劃的信息設(shè)計師和架構(gòu)師;
b) 確定預(yù)期用戶將用軟件執(zhí)行的任務(wù)的易用性專家和商業(yè)分析師;
c) 開發(fā)和編輯用戶文檔書面內(nèi)容的人員;
d) 具備電子媒體專業(yè)知識的平面設(shè)計師;
e) 共同設(shè)計文檔在屏幕上的呈現(xiàn)形式的用戶界面設(shè)計師和人類工效學(xué)專家。
本標準還可供文檔編制過程中的其他角色和利益相關(guān)方查閱:
a) 軟件開發(fā)過程或文檔編制過程的管理人員;
b) 閱讀由供方編制的文檔的需方;
c) 易用性測試人員、文檔評審人員和領(lǐng)域?qū)＜?
d) 屏顯文檔創(chuàng)建工具的開發(fā)者;
e) 確定原則使文檔更易于理解和易于使用的人為因素專家。