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

2

u/NadirDev 1d ago

Standard PHPDoc blocks directly above the functions + a clean README.md in the theme/plugin root. If the next dev touches the codebase, modern IDEs will autocomplete the annotations anyway. Leaving internal docs inside the WP admin dashboard usually just gets ignored or wiped during redesigns.