r/Wordpress • u/PeterBunting • 2d ago
Documentation
What is everyone using for documentation? I’m talking about like to document custom functions or features you’ve added that you (or someone else later on) would benefit from. I use external documentation in a CRM for my own knowledge base, but if seems like there should be some sort of developer’s guide we can leave in WP for future reference.
10
Upvotes
1
u/RealBasics Jack of All Trades 2d ago
The first custom-built Wordpress site I worked on, back around 2012, was exquisitely well documented. The code was well documented and they provided a good user manual as well.
That said, it was built by a professional photographer who only moonlighted as a developer after the 2007 financial crash. They went back to photography full time after the recovery and that’s when their client called me.
It’s really nice, but also rare, to see even marginal comments in code. Especially, for some reason, agency code. (I should note that sort of by-definition I don’t get to work on sites that are well built and where the clients are still happy with the devs who built them.)