Re: In-house Reusable Code: Publishing and Documenting

over the years we have created an i house system using


DSPFD FILE(*ALLUSR/*ALL) TYPE(*MBR) +
OUTPUT(*OUTFILE) OUTFILE(SRCSCH/SRCSCH)
DSPFD FILE(&SRCLIB/*ALL) TYPE(*BASATR) +
OUTPUT(*OUTFILE) FILEATR(*PF) +
DSPFD FILE(&ATLIB/&ATFILE) TYPE(*MBRLIST) +
OUTPUT(*OUTFILE) +

we create indexes and run programs against the output to find procedures in
service programs and create a google like search over the source members
and objects in the libraries we are interrested in.

even though there are only 2 of us I don't know how we would work without
it. am intending on sharing it with a local user group soon. If it is
perfected for distribution and you are interrested, we may be able to get
it out to the public.

Jim


message: 8
date: Fri, 6 Jan 2012 09:09:16 -0500
from: Jon Paris <jon.paris@xxxxxxxxxxxxxx>
subject: Re: In-house Reusable Code: Publishing and Documenting


On Jan 6, 2012, at 2:08 AM, midrange-l-request@xxxxxxxxxxxx wrote:

Have any of you found good answers to either of these questions for a
shop with 5 or more developers?

1) How do y?all make people aware what reusable routines exist?

2) How do folk find what a reusable routine does, short of reading the

code?

Documentation? <grin>

The best way I believe is to use an RPGDoc tool (Paul Tuohy has one linked
from here http://systemideveloper.com/downloads.html )

We have also used a wiki (pmwiki in our case) as a central repository for
documentation.

I also subscribe to the notion of using the prototypes for basic
documentation and examples of useage. I also group the protos of multiple
routines into a single file to minimize the number of places that have to
be searched.

Jon Paris