工程師看書 | 《高品質文件 持續分享技術與知識》| 認識活文件

Winsome on 2021-04-25 Sun

今天來分享《高品質文件 持續分享技術與知識》
我覺得這本超棒!作者能把這麼無聊的主題,寫得這麼有意思!真是厲害!
在為寫文件而煩惱嗎?
有沒有人教過你怎麼寫文件呢?
一起來看看吧

大綱

  • 我們的文件出了什麼問題
    活動分離、想到什麼寫什麼、換句話說、不實用
  • 要寫文件之前,先問自己三個問題
    真的需要這個文件嗎?真的立即需要這個文件嗎?能不能只透過交談或一起工作來分享知識?
  • 寫文件到底要寫什麼?哪些要寫?
    文件的目的是什麼?專屬知識&通用知識、穩定&變動
  • 活文件的作法和工具
    ADR、Dependency Cruiser、Annotaion