This week on the present, the crew talks about documentation. Yay! As builders, there is not any doubt that all of us love consuming nice documentation – particularly for APIs. However, nary a one among us enjoys the method of making documentation. Besides perhaps Adam, who’s oddly enthusiastic about communication. For the remainder of us, nevertheless, documenting our decisions and our subsequent outcomes feels a little bit of a slog. It is by no means clear once we needs to be writing documentation; it is by no means clear what we needs to be documenting; and, it is by no means clear simply how a lot element we have to embrace. And generally, mockingly, plainly the extra completely we doc a subject, the extra probably it’s to be misunderstood. So, that is superior!
All that and extra on this week’s present:
… that includes these lovely, lovely folks:
With audio modifying and engineering by ZCross Media.
For the complete present notes and hyperlinks, go to the episode web page. And, be sure you observe the present and come chat with us on Discord! Our web site is workingcode.dev and we’re @WorkingCodePod on Twitter and Instagram. New episodes drop weekly on Wednesday.
