日本免费高清视频-国产福利视频导航-黄色在线播放国产-天天操天天操天天操天天操|www.shdianci.com

學無先后,達者為師

網站首頁 編程語言 正文

軟件文檔編寫規范(技術文件編寫規范)

作者:小心小新啊 更新時間: 2022-03-14 編程語言

軟件文檔的質量甚至關乎項目的最終成敗和可維護性。文檔編寫需要遵守以下規范:

1、針對性。文檔編制前應分清讀者對象。對不同的類型、不同層次的讀者,決定如何滿足適應他們的需要。
2、精確性。文檔的行文應當十分確切,不能出現多義性的描述。
3、清晰性。文檔編寫應力求簡明,如有可能,配以適當的圖表,以增強其清晰性。
4、完整性。任何一個文檔都應當是完整的、獨立的,它應自成體系。例如,前言部分應做一般性介紹,正文給出中心內容,必要時還有附錄,列出參考資料等。
5、靈活性。各個不同軟件項目,其規模和復雜程度有著許多實際差別,不能相同看待。

原文鏈接:https://blog.csdn.net/xal0610/article/details/113887082

欄目分類
最近更新