如何寫文件 問題的提出

2021-04-21 12:18:38 字數 401 閱讀 8917

在測試時寫了一些test step,手工測試,內容很繁雜,步驟按要求寫到極細,只要按著一步步走就能做出來。(這裡也有乙個分清主次關係的問題,不是所有東西都要寫出來的,要區分大家都懂的(傻瓜級的)和特殊的地方(這裡要重點寫)。

但是在實際使用過程中,碰到大家都不願意用的情況,首先是直接沒看,叫你直接demo;還有看了一會看不下去,還是叫你demo。以致該文件沒有起到應有的作用。文件不願看的情況,只能怪文件作者寫的不好,就好比學生學不好是因為老師的原因,我一直這麼認為。

為什麼文件別人看不懂,不想看?

很多時候是因為結構不行,沒有重點,沒有提綱,看著實在費事,所以不如直接叫人。

其實文件的寫法就存在於已有的各種優秀文件之中,只要總結各種優秀文件的格式,純文字、rtf,doc,pdf,html,就可以寫出結構好而重點突出的文件。

介面文件要如何寫

乙個簡單的介面文件,寫完給組長看後,發現漏洞百出。下面總結一下寫文件需要注意事項 封面最好是本公司規定的封面,有logo,內容標題,版本號,公司名稱,文件產生日期。錯誤地方在於,文件的標題要和頁首中的標題一致 形式較好些。包括,版本,修訂說明,修訂日期,修訂人,審核時間審核人。我錯誤的地方在於,中其...

如何寫詳細設計文件

在大多數軟體專案中,要末不作詳細設計,要麼開發完成後再補詳細設計文件,質量也不容樂觀,文件與系統往往不能同步,使詳細設計文件完全流於形式,對工作沒有起到實際的幫助。那到底應不應該寫詳細設計文件呢,怎麼使詳細設計文件起到他應有的作用呢,下面就讓我們來認識一下詳細設計及寫詳細設計文件的好處和問題。什麼是...

如何寫詳細設計文件

在大多數軟體專案中,要末不作詳細設計,要麼開發完成後再補詳細設計文件,質量也不容樂觀,文件與系統往往不能同步,使詳細設計文件完全流於形式,對工作沒有起到實際的幫助。那到底應不應該寫詳細設計文件呢,怎麼使詳細設計文件起到他應有的作用呢,下面就讓我們來認識一下詳細設計及寫詳細設計文件的好處和問題。什麼是...