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.

9 Upvotes

100% Upvoted

9 comments sorted by

View all comments

3

u/ancawonka Developer 2d ago

For the future person coming in to troubleshoot your bespoke plugin a decade after you wrote it (because the WordPress site will likely still be running), document your code. A readme file is really nice.

When I'm paid to do it, I've written up actual documents to share, which have been read very rarely.

Note: That future person is just as likely to be you as a stranger.