Regulatory Open Forum

I do a lot of technical writing (webinars, seminars, workshops, etc.) and have a question about the more effective way to write examples.

It seems to me there are two methods, using pronouns and using (made up) names.

In the first case (pronoun based), I might say:

A doctor diagnoses a patient with Type II diabetes; the doctor asks the patient to check her blood glucose each day. The doctor prescribes a starter kit with a four different devices: a blood glucose meter, a device to “fire” the lancet, a package of lancets, and a package of blood glucose test strips.

In the second case (personalized case), I might say:

Dr. Amita Gupta diagnoses her patient, Emily O’Conner with Type II diabetes; Dr. Gupta asks Ms O’Conner to check her blood glucose each day. Dr. Gupta prescribes a starter kit with a four different devices: a blood glucose meter, a device to “fire” the lancet, a package of lancets, and a package of blood glucose test strips.

I do this kind of thing so often, that I’m immune to the differences. However, a lot of literature uses the more personalized example type. In particular, IRS guidance documents seem to be particularly good at personal examples, small worksheets, etc.

Is there a standard that describes the best approach? If not, is there a documented best practice for which you could provide a reference?

I do a lot of technical writing (webinars, seminars, workshops, etc.) and have a question about the more effective way to write examples.

It seems to me there are two methods, using pronouns and using (made up) names.

In the first case (pronoun based), I might say:

A doctor diagnoses a patient with Type II diabetes; the doctor asks the patient to check her blood glucose each day. The doctor prescribes a starter kit with a four different devices: a blood glucose meter, a device to “fire” the lancet, a package of lancets, and a package of blood glucose test strips.

In the second case (personalized case), I might say:

Dr. Amita Gupta diagnoses her patient, Emily O’Conner with Type II diabetes; Dr. Gupta asks Ms O’Conner to check her blood glucose each day. Dr. Gupta prescribes a starter kit with a four different devices: a blood glucose meter, a device to “fire” the lancet, a package of lancets, and a package of blood glucose test strips.

I do this kind of thing so often, that I’m immune to the differences. However, a lot of literature uses the more personalized example type. In particular, IRS guidance documents seem to be particularly good at personal examples, small worksheets, etc.

Is there a standard that describes the best approach? If not, is there a documented best practice for which you could provide a reference?