Talk in English - US at Longhorn PHP Conference 2023
Track Name:
Elm
View Slides: https://stevegrunwell.com/slides/write-some-docs
Short URL: https://joind.in/talk/a402b
(QR-Code (opens in new window))
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
Comments are closed.
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.
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!
Excellent talk! Very engaging and energetic with great, actionable examples.
Loved it.
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.
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!