John M. Dlugosz has asked for the wisdom of the Perl Monks concerning the following question:

Working on Exporter::VA, I want documentation aimed at two different kinds of user. Someone may be using this module during the writing of another module to provide the import function for that module; and someone else may use that module.

The first user needs to know how to formulate an export definition. The second user needs to know what he can put on the use parameter list.

Internally, I need to keep these two rolls straight to avoid confusion over when something is happening.

So what do I call them? I think good names can make a difference.

Replies are listed 'Best First'.
Re: Nomenclature: names for roles
by fglock (Vicar) on Nov 06, 2002 at 17:20 UTC

    The person who reads your pod is the first kind of user. So just do your normal module documentation for him/her.

    The second kind of user will read the documentation written by the first user. So you can add a "How to document your module" section in your pod. There you can tell your user what to say to his users.

Re: Nomenclature: names for roles
by hawtin (Prior) on Nov 06, 2002 at 21:28 UTC

    I agree, it is a good idea to select some names and stick to them. It makes it easier to write documents and reduces confusion. I would suggests that the most important step is deciding to use specific names, which names you actually pick are unimportant (so long as everyone knows what you mean)

    In one of my software systems we refer to:

    • The "End User" who actually does the work
    • The "Architect" who designs how bits go together
    • The "Builder" who codes each bit

    It sounds like your system won't quite match but this suits our way of working.

    Another trick I have seen (but don't use myself) is to always mark out the name (say in italics) to remind readers that you are talking about a specific role when you use the name.

      Hmm, in Cryptography, the names Alice, Bob, etc. are used. You set up the situation, and then use the names instead of "the sender" etc.

      Without good succinct roll names, perhaps a sentence to introduce and explain the role of each Proper Name would make for a clear document.