It takes a special kind of person to enjoy writing documentation; not only do I have to write [ideally] working code, but now I have to write words that a human being can understand? What is this madness?!

Luckily, good documentation isn't limited to the confines of your codebase. By following common documentation standards, we can generate comprehensive manuals that instruct others how to integrate with our software. After all, to code is human, but to document is divine.


Comments are closed.

Ryan Marks at 13:09 on 3 Nov 2023

I loved your energy and passion for documentation. I left your talk wanting a taco and the lunch satisfied that for sure.

Nice job. I enjoyed your energy. I wish you had addressed the "my code is my documentation" school of thought more.

Nick A at 20:38 on 3 Nov 2023

Do you want to know about documentation? Inline? External? Something else? This talk has you covered. I found the details of docblocks to be particularly useful. I also appreciated the comparisons of different documentation systems on the same set of code

And never forget: RTFM!

Eric Minaker at 10:14 on 4 Nov 2023

Excellent talk! Very engaging and energetic with great, actionable examples.

michael kimsal at 11:19 on 4 Nov 2023

Loved it.

Peter Meth at 14:29 on 4 Nov 2023

Documenting is a topic that is near and dear to me so I appreciated this talk. However the strategies seemed to ignore some common tools such as wikis. There alao was not much mention of documenting APIs which is a common task for PHP developers.

Ben Ramsey at 15:14 on 4 Nov 2023

Entertaining and engaging, as always. Great arguments for why doc are important and should be kept up-to-date, and good examples of how to use docblocks. I agree with others who mentioned expanding the talk to discuss other places/strategies for documentation.

Good actionable take-aways to improve application documentation. Thanks for documenting your talk for easy reference!