網站首頁 編程語言 正文
軟件文檔的質量甚至關乎項目的最終成敗和可維護性。文檔編寫需要遵守以下規范:
1、針對性。文檔編制前應分清讀者對象。對不同的類型、不同層次的讀者,決定如何滿足適應他們的需要。
2、精確性。文檔的行文應當十分確切,不能出現多義性的描述。
3、清晰性。文檔編寫應力求簡明,如有可能,配以適當的圖表,以增強其清晰性。
4、完整性。任何一個文檔都應當是完整的、獨立的,它應自成體系。例如,前言部分應做一般性介紹,正文給出中心內容,必要時還有附錄,列出參考資料等。
5、靈活性。各個不同軟件項目,其規模和復雜程度有著許多實際差別,不能相同看待。
原文鏈接:https://blog.csdn.net/xal0610/article/details/113887082
相關推薦
- 2023-01-12 Python讀取及保存mat文件的注意事項說明_python
- 2022-08-04 十分鐘教會你用Python處理CSV文件_python
- 2022-08-03 goFrame的隊列gqueue對比channel使用詳解_Golang
- 2022-04-11 css實現左邊div固定寬度,右邊div自適應撐滿剩下的寬度
- 2023-06-03 React實現一個倒計時hook組件實戰示例_React
- 2023-04-22 python的open函數使用案例代碼_python
- 2022-03-14 idea中的子模塊無法新建class的解決方法(idea編譯沒有生成class文件)
- 2022-07-26 通過驅動修改USB轉串口設備的友好名稱
- 最近更新
-
- window11 系統安裝 yarn
- 超詳細win安裝深度學習環境2025年最新版(
- Linux 中運行的top命令 怎么退出?
- MySQL 中decimal 的用法? 存儲小
- get 、set 、toString 方法的使
- @Resource和 @Autowired注解
- Java基礎操作-- 運算符,流程控制 Flo
- 1. Int 和Integer 的區別,Jav
- spring @retryable不生效的一種
- Spring Security之認證信息的處理
- Spring Security之認證過濾器
- Spring Security概述快速入門
- Spring Security之配置體系
- 【SpringBoot】SpringCache
- Spring Security之基于方法配置權
- redisson分布式鎖中waittime的設
- maven:解決release錯誤:Artif
- restTemplate使用總結
- Spring Security之安全異常處理
- MybatisPlus優雅實現加密?
- Spring ioc容器與Bean的生命周期。
- 【探索SpringCloud】服務發現-Nac
- Spring Security之基于HttpR
- Redis 底層數據結構-簡單動態字符串(SD
- arthas操作spring被代理目標對象命令
- Spring中的單例模式應用詳解
- 聊聊消息隊列,發送消息的4種方式
- bootspring第三方資源配置管理
- GIT同步修改后的遠程分支