Monday, January 4, 2010

It's Not My Documentation

Almost every software developer knows it's good to document their software.
Almost every software developer doesn't.
Almost every software developer is smart.

Therefore, it is smart not to document software!

I say that partly in jest, but I really do think software developers are just not ideal at writing documentation. It's not that we're bad at writing. Most developers I've known are actually pretty good writers. The real reason software developers make such poor documenters is we generally don't know how to think like our audience. Writing documentation is like writing code--understanding the needs of the end user is critical. Our technical training simply doesn't prepare us to do well.

I've never tried this, but it seems that an ad-hoc team made up of a documentation consumer (at the keyboard) and a programmer (to provide information) would make a powerful combination.

38 comments:

  1. just wanted to share a resource on how to write maintainable code, though not written by me, it's good.

    files.meetup.com/120980/Writing%20Maintainable%20Code.ppt

    dedicated software developers

    ReplyDelete
  2. 永遠不要躊躇伸出你的手。也永遠不要躊躇接受別人伸出的手。..................................................

    ReplyDelete
  3. Never put off till tomorrow what may be done today.......................................................

    ReplyDelete
  4. 用行動來支持你~~~不留言不行!........................................

    ReplyDelete
  5. 睇完之後覺得有d頓悟..感謝分享..........................

    ReplyDelete
  6. 天下沒有走不通的路,沒有克服不了的困難,沒有打不敗的敵人。.............................................

    ReplyDelete
  7. 每個人生命中都可能遇到貴人,這些貴人不一定真的尊貴,他可能是陌生人,也可能是你的敵人。..................................................

    ReplyDelete
  8. 先將一個人的生活過好,才有能力過好兩個人的生活........................................

    ReplyDelete
  9. 婚姻對男人來說是賭他的自由,對女人而言卻是賭她的幸福。..................................................................

    ReplyDelete
  10. 知識可以傳授,智慧卻不行。每個人必須成為他自己。....................................................................

    ReplyDelete
  11. 人不能像動物一樣活著,而應該追求知識和美德....................................................................

    ReplyDelete
  12. 一個人的價值,應該看他貢獻了什麼,而不是他取得了什麼............................................................

    ReplyDelete
  13. 如果成為一支火柴,也要點亮一個短暫的宇宙;如果是一隻烏鴉,也要叫疼閉塞的耳膜。.................................................................

    ReplyDelete
  14. 沒有經過反省的人生,是不值得活的人生..................................................

    ReplyDelete
  15. 生活總是起起伏伏,心情要保持快樂才好哦!!.......................................................

    ReplyDelete
  16. 河水永遠是相同的,可是每一剎那又都是新的。..................................................

    ReplyDelete
  17. 很喜歡你的部落格,來給你加油,幫你推一下喔~期待你的下一個更新,謝謝............................................................

    ReplyDelete
  18. 安安唷~~幸運的日子送給妳(你)滿滿的幸福,也祝福你天天都開心唷...........................................................

    ReplyDelete
  19. 財富並非永遠的朋友,但朋友卻是永遠的財富。......................................................................

    ReplyDelete
  20. 開心不開心都是一天,祝您能夠笑著面對一切!...............................................................

    ReplyDelete