Home / Ongoing Work / Audits, Reports & Documentation / Theme & codebase documentation generation

We generate technical documentation of your theme and custom code — custom functions, hooks, template logic — by analysing the actual codebase, useful for a developer who needs to maintain or extend code that was never documented as it was written. This is code-level detail, distinct from a higher-level architecture overview.

AIX-012

Theme & codebase documentation generation

Your theme's custom code documented at the level a developer actually needs.

$219.49 delivered in 72 hours
Needs SFTP access and WP admin login. Create a limited sub-account — we never ask for your own password.
  • Full backup taken before we start
  • If we can’t fix it, you get your money back
  • We never ask for your own password

What we need from you

  • FTP or code access to the theme and any custom plugins
  • Confirmation of which parts of the codebase matter most, if you want a specific focus
  • Your preferred documentation format

This or something else?

You want your theme’s custom code documented at a technical, code level for a developer’s use This fix covers it
You want a higher-level, less technical architecture overview for stakeholders Technical architecture document, in the Documentation & Handover category, a different level of detail
You want an onboarding pack for an incoming developer, which may include this alongside other documents Onboarding pack for incoming developer, in the Documentation & Handover category, a broader bundle
You want your custom post types and fields documented, not general theme code Data structure documentation report, in the Integrations & Automation bucket

What we do

  1. Review the theme and custom plugin code comprehensively
  2. Document custom functions, hooks, and template logic
  3. Note dependencies and any non-obvious behaviour found
  4. Compile findings into clear, organised technical documentation
  5. Include enough detail to be genuinely useful for a developer maintaining the code
  6. Review for accuracy before considering it final

What is included

  • Technical documentation of custom theme and plugin code
  • Documented functions, hooks, and template logic
  • Notes on dependencies and non-obvious behaviour
  • A clear, organised reference document

Not included

  • A higher-level, non-technical architecture overview — a separate, different-level document
  • Documenting third-party plugins’ own code, beyond how your custom code interacts with them
  • Fixing any issues found while documenting — a separate, related fix
  • Ongoing updates as the codebase changes

Questions about this fix

How is this different from the technical architecture document?

That document gives a broader, less code-detailed overview suited to stakeholders; this is specifically code-level documentation — actual functions, hooks, and logic — suited to a developer who needs to work directly with the code.

Will this cover third-party plugins I've installed?

Only how your custom code interacts with them, not the plugins' own internal code, which is outside what we'd document here.

Is this worth doing if I'm not planning to change developers soon?

Even without an imminent handover, documentation reduces risk if your current developer becomes unavailable, and makes future work faster regardless of who does it.

Will this need updating as the codebase changes?

Yes, this reflects the codebase as of when it's documented — significant future changes would need a follow-up update to stay accurate.

Does this include the onboarding pack for a new developer?

Not on its own — this is one component; the onboarding pack is a broader bundle that can include this alongside other documents.

Theme & codebase documentation generation
$219.49 · delivered in 72 hours · needs SFTP access, WP admin login

Related fixes

If this is the second time this year

A bad update breaking the site is a symptom of updates not being tested first. Care plans run every update on a staging clone before it reaches your live site, which is the actual fix for this happening again.

See care plans

Your access, your rules

Create a separate admin account for us and delete it when we are done. For anything else, we get in touch and agree a method — never a form field on this site, never by reply to an email.

We back up first, always

Before anything is touched we take a full backup and keep it for 30 days. If a fix goes wrong, we put the site back exactly as it was.

If it is not what you bought

If the problem turns out smaller than what you ordered, we refund the difference. If it is bigger, we stop and send a quote before doing any extra work.

If we cannot fix it

You get back what we received. Diagnosis is on us — you only pay when the problem is actually solved. The payment processor takes its fee before the money reaches us, so we never hold it and it is not ours to return. That is true here as everywhere else.

If it comes back

Reply within seven days of delivery and we put it back on the bench at no cost. The fix is not finished until it holds.

What we are responsible for

If something goes wrong with a fix, our responsibility is limited to what you paid for it. We take a full backup first so mistakes can be undone, and we tell you before doing anything outside what you bought.