Cory Flowers, Quest Guest Blogger | Blog content sourced from Ps_App_Development

I use these program documentation scripts every single time I need to document a program. This allows me to be consistent and have the same exact documentation style every time. I do not need to go out and look for how I did it last time. I run these scripts below and my documentation is automatically completed for me. I just drop the results in my application. This is a very nice touch to making your code look professional, and it gives the customer a very nice and easy way to track modifications in their PeopleSoft System during upgrades and when auditing their systems.

From my experience as a developer, this is one of the most overlooked aspects of building or modifying an application. I have personally seen many occasions where a developer documented their code and it was very difficult to decipher why they did the modification and what else the modification was tied to. Companies should really implement a documentation standard so that everyone is on the same level of documentation standards when developing applications.

To use this method of documentation, you will need to copy this code into your SQL tool and run the scripts. You will be prompted for the needed information. Once you enter the data, you will run the script and in the results window you will have your documentation nice and neat and ready for you to place in your program.

———————————————————————————————————————————————————————————

———————————————————————————————————————————————————————————
—                                        SQR DOCUMENTATION                                                                       —
———————————————————————————————————————————————————————————
———————————————————————————————————————————————————————————

——————————–
—— MAIN DOCUMENTATION ——
——————————–

Select INITCAP(‘!’||’ ‘||’Company Name’) AS PROPERTY_DOCUMENTATION FROM DUAL
UNION ALL
Select INITCAP(‘!’||’ ‘||’AUTHOR: ‘||’Your Name’) FROM DUAL
UNION ALL
Select INITCAP(‘!’||’ ‘||’DATE: ‘|| CURRENT_DATE ) FROM DUAL
UNION ALL
Select ‘!’||’ ‘||’Work Unit / SR: ‘|| ‘&TICKET’ FROM DUAL
UNION ALL
Select INITCAP(‘!’||’ ‘||’DESCRIPTION: ‘|| ‘&DESCRIPTION’ ) FROM DUAL;

————————————-
—— START AND FINISH OF MOD ——
————————————-

Select ‘!***’||’ ‘||’Begin Mod’||’ / ‘||’Company Name’||’ / ‘||’Your Name’||’ / ‘||CURRENT_DATE||’ / ‘|| ‘&TICKET’ ||’ / ‘||’&DESCRIPTION’||’ ‘||’***!’ AS START_N_END_MOD FROM DUAL
UNION ALL
Select ‘!***’||’ ‘||’End Mod’||’ / ‘||’Company Name’||’ / ‘||’Your Name’||’ / ‘||CURRENT_DATE||’ / ‘|| ‘&TICKET’ ||’ ‘||’***!’  FROM DUAL;

—————————–
—— SINGLE LINE MOD ——
—————————–

Select ‘!***’||’ ‘|| ‘&TICKET’ ||’ / ‘||’Company Name’||’ / ‘||’Your Name’||’ / ‘||CURRENT_DATE||’ ‘||’***!’ AS SINGLE_LINE_CHANGE  FROM DUAL;

———————————————————————————————————————————————————————————
———————————————————————————————————————————————————————————
—                                           PEOPLECODE DOCUMENTATION                                                        —
———————————————————————————————————————————————————————————
———————————————————————————————————————————————————————————

———————————————
—— OBJECT PROPERTIES DOCUMENTATION ——
———————————————

Select INITCAP(‘Company Name’) AS PROPERTY_DOCUMENTATION FROM DUAL
UNION ALL
Select INITCAP(‘AUTHOR: ‘||’Your Name’) FROM DUAL
UNION ALL
Select INITCAP(‘DATE: ‘|| CURRENT_DATE ) FROM DUAL
UNION ALL
Select ‘Work Unit / SR: ‘|| ‘&TICKET’ FROM DUAL
UNION ALL
Select INITCAP(‘DESCRIPTION: ‘|| ‘&DESCRIPTION’ ) FROM DUAL;

————————————-
—— START AND FINISH OF MOD ——
————————————-

Select ‘REM’||’ — ‘||’Begin Mod’||’ / ‘||’Company Name’||’ / ‘||’Your Name’||’ / ‘||CURRENT_DATE||’ / ‘|| ‘&TICKET’ ||’ / ‘||’&DESCRIPTION’ || ‘;’ AS START_N_END_MOD  FROM DUAL
UNION ALL
Select ‘REM’||’ — ‘||’End Mod’||’ / ‘||’Company Name’||’ / ‘||’Your Name’||’ / ‘||CURRENT_DATE||’ / ‘|| ‘&TICKET’ || ‘;’  FROM DUAL;

—————————–
—— SINGLE LINE MOD ——
—————————–

Select ‘REM’||’ — ‘|| ‘&TICKET’ ||’ / ‘||’Company Name’||’ / ‘||’Your Name’||’ / ‘||CURRENT_DATE || ‘;’ AS SINGLE_LINE_CHANGE  FROM DUAL;

Want more tips and tricks from actual PeopleSoft customers? Register for PeopleSoft RECONNECT, the only deep-dive PeopleSoft conference for all industries. You’ll get in-depth education and networking to take your PeopleSoft knowledge to the next level.