We recently went the way of wiki for documentation for our company, and I have made great use of it to document our service programs' exported procedures. The other nice thing about it is that for people who don't use RDp, or who do but still have a hard time navigating to find where a procedure is from, they can search on it in the wiki and find the procedure.
For us, I created a standard layout as well. Here is a screenshot of one of our pages:
http://i.imgur.com/POI6b.jpg
There is a bit of initial investment to get pages out there for existing service programs, but I've received positive feedback about having the information on the wiki.
-Kurt
-----Original Message-----
From: midrange-l-bounces@xxxxxxxxxxxx [mailto:midrange-l-bounces@xxxxxxxxxxxx] On Behalf Of Jerry C. Adams
Sent: Friday, January 06, 2012 8:55 AM
To: 'Midrange Systems Technical Discussion'
Subject: RE: In-house Reusable Code: Publishing and Documenting
I like the idea of a wiki. I tried to get one set up at my last job for user procedures/processes, but it could have included programming documentation, too. Never got implemented before they closed the doors.
As a one-man shop for years, I keep my documentation for these things in a combination of Word documents, which define the interface and what the function/program does, and Excel spreadsheet. Not practical for a multi-person shop.
Jerry C. Adams
IBM i Programmer/Analyst
Hospitality is making your guests feel at home even when you wish they were.
--
A&K Wholesale
Murfreesboro, TN
615-867-5070
-----Original Message-----
From: midrange-l-bounces@xxxxxxxxxxxx
[mailto:midrange-l-bounces@xxxxxxxxxxxx] On Behalf Of Jon Paris
Sent: Friday, January 06, 2012 8:09 AM
To: midrange-l@xxxxxxxxxxxx
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
www.partner400.com
www.SystemiDeveloper.com
--
This is the Midrange Systems Technical Discussion (MIDRANGE-L) mailing list To post a message email: MIDRANGE-L@xxxxxxxxxxxx To subscribe, unsubscribe, or change list options,
visit:
http://lists.midrange.com/mailman/listinfo/midrange-l
or email: MIDRANGE-L-request@xxxxxxxxxxxx Before posting, please take a moment to review the archives at
http://archive.midrange.com/midrange-l.
--
This is the Midrange Systems Technical Discussion (MIDRANGE-L) mailing list To post a message email: MIDRANGE-L@xxxxxxxxxxxx To subscribe, unsubscribe, or change list options,
visit:
http://lists.midrange.com/mailman/listinfo/midrange-l
or email: MIDRANGE-L-request@xxxxxxxxxxxx Before posting, please take a moment to review the archives at
http://archive.midrange.com/midrange-l.
midrange.com
