Talk in English - US at CascadiaPHP 2024
Track Name:
Crater Lake
View Slides: https://stevegrunwell.com/slides/write-some-docs
Short URL: https://joind.in/talk/aded3
(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 lives on outside 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
Please login to leave a comment
Good basic information. I've written both online and external documentation for many years, and still learned a few things. An advanced version describing techniques for documenting complex concepts, and some if the standardized techniques for specific kind of documentation (data flows, etc) might be nice.
Preach on man! I wish more folks we do this. Especially in libraries.
As a person who writes one-line comments, I really didn't see the value in writing PHPdoc style comments. This talk convinced me I was wrong. I picked up a lot and this is going to push my dept code quality up significantly .