◆ Salesforce

Document Apex class files

This is real work, not a feature someone invented — it comes from real job ads and real questions people asked. Below are four ready AI prompts: get it done, make it easy for the next person to say yes to, work out the right move when you are stuck, and stop it coming back.

4prompts

The same task, four prompts

today's deadline · the next reviewer · the stuck moment · the pattern
AExecute — do the immediate taskAdd a Javadoc-style comment block to the `OpportunityHelper` Apex class, describing its…+
Add a Javadoc-style comment block to the `OpportunityHelper` Apex class, describing its purpose, author as 'Jane Doe', and creation date as '2023-10-26'.
when the reply comes backPush once: ask it to sharpen the weakest part, and to say what it assumed. Helpful?
BImprove — make it easier to acceptBefore I commit this new `LeadProcessor` Apex class, help me document it thoroughly. I want to…+
Before I commit this new `LeadProcessor` Apex class, help me document it thoroughly. I want to make sure it's clear for any future developer what this class does, what its key methods are, and any important considerations for maintenance or potential side effects. Think about someone who's never seen this code before and needs to understand it quickly.
when the reply comes backPush once: ask it to sharpen the weakest part, and to say what it assumed. Helpful?
CDecide — diagnose the stuck momentA new team member just wasted two days trying to grok the `OrderService` Apex class because its…+
A new developer just spent two days trying to understand a critical Apex class because the existing documentation was outdated and incomplete.
A new team member just wasted two days trying to grok the `OrderService` Apex class because its documentation was completely out of sync with the code and missed crucial dependencies. I'm afraid this will keep happening with our older, less-documented classes, slowing down onboarding and increasing the risk of errors. I can't tell my manager how much time was really lost. What's the most critical information to capture when retroactively documenting a complex, undocumented Apex class, and what's the best first step to get it right without rewriting everything?
when the reply comes backPush once: ask it to sharpen the weakest part, and to say what it assumed. Helpful?
DBecome — change the patternI'm always behind on documenting Apex classes, or the documentation I write quickly becomes…+
I consistently struggle to keep Apex class documentation current and useful, leading to confusion and rework for the team.
I'm always behind on documenting Apex classes, or the documentation I write quickly becomes stale. This leads to endless questions from other developers and slows down debugging. What habit should I change to ensure documentation is consistently updated and truly helpful, rather than just a chore I rush through?
when the reply comes backPush once: ask it to sharpen the weakest part, and to say what it assumed. Helpful?

Questions people actually ask

honest answers, no sign-up

Every task here was seen in the real world. Someone doing the job named it, a real job ad asked for it, or a lot of people asked about it online.

If nothing real showed a task, it is not on the page. That is the whole rule.

They are the same job approached four ways, because what you need depends on where you are.

Get it done today. Make it easy for the next person to say yes to. Work out the right move when you are stuck. Learn the pattern so the job stops coming back.

For most of these jobs it can carry the heavy thinking - draft it, sort it, check it, rehearse it with you.

It cannot sit in your chair, take the blame when a number is wrong, or notice what nobody wrote down. Let it do the first 80%. Keep the last 20% that is truly yours.

No. Copy any prompt and paste it into the AI you already use. No account, no score, no wall in the way.

Any of them. The prompts describe the work rather than naming a product, so they are not tied to one assistant.

That is also why they keep working when you switch.

Change it freely. Every prompt is a starting line, not a rule.

Put in your real numbers, your real names and your real deadline. The more you make it yours, the better the answer comes back.

The tasks come from real job ads, published job data and the questions people ask in public forums.

The steps come from Salesforce's own documentation, with practitioner sources for the traps the manual does not mention.

Push once. Ask it to sharpen the weakest part and to say what it assumed.

Most wrong answers come from a missing detail rather than a bad prompt - tell it the thing it could not know.