Conversation

Notices

1. Embed this notice
   Simon Willison (simon@fedi.simonwillison.net)'s status on Wednesday, 13-Nov-2024 05:56:24 JST Simon Willison

   The more experience I gain as a software developer the less tolerance I have for the idea that something doesn't need documenting if you can go and read the source code instead

   (That's despite getting much, much better at reading source code to answer my own questions as I gain experience)

   • Embed this notice
     Simon Willison (simon@fedi.simonwillison.net)'s status on Wednesday, 13-Nov-2024 10:48:02 JST Simon Willison

     in reply to

     I wrote a bunch more about my own approach to documentation here: https://simonwillison.net/2022/Nov/26/productivity/

   • Embed this notice
     Simon Willison (simon@fedi.simonwillison.net)'s status on Wednesday, 13-Nov-2024 10:48:03 JST Simon Willison

     in reply to

     I should clarify: when I talk about documentation here I'm not talking about code comment style docs - I'm talking about "this is how to use this library / API" docs

     If your code is clearly written and nothing else ever needs to call it then I don't particularly mind if there's no additional documentation - but if I'm expected to use call your library from my own code I'm very much not keen on being told I have to read all of that code myself just to use it!

     esmevane, sorry repeated this.