hexagon logo
Register Sign in
  • Replies 8 replies
  • Subscribers 222 subscribers
  • Views 92 views
  • Users 0 members are here
Options
Related

Programmer/Authors Notes

acgarcia
Just wanted to see what everyone else is doing. I need to get in the habit of documenting like the date I proved a program in $$ comment for record keeping and just general notes of changes I made.

Does anyone have a specific format or style that they can share for ideas? I'm thinking something like my Name, Date, maybe CAD revision, drawing names and revisions?

Thanks.
Parents
  • I use document comments to keep track of program changes. This allows me to track any program changes down the line by knowing what has been changed that could have caused an issue if any arise. I also keep the backup of the program prior to changes in the event a change needs to be reversed.
    My format looks like this:
    *********************************************************PROGRAM HISTORY*********************************************************
    12.19.22 "OPERATOR NAME"-"DESCRIPTION OF CHANGES/COMMENTS"
    ********************************************************************************************************************************************

    We do the same thing in our programs and we also use our doc control software to keep the latest changes in the correct folder. The doc control software also gives us access to previous versions of said program as far back as initial creation. By saving each changed version of a program into doc control has saved me many a time when someone made changes without going through doc control.

Reply
  • I use document comments to keep track of program changes. This allows me to track any program changes down the line by knowing what has been changed that could have caused an issue if any arise. I also keep the backup of the program prior to changes in the event a change needs to be reversed.
    My format looks like this:
    *********************************************************PROGRAM HISTORY*********************************************************
    12.19.22 "OPERATOR NAME"-"DESCRIPTION OF CHANGES/COMMENTS"
    ********************************************************************************************************************************************

    We do the same thing in our programs and we also use our doc control software to keep the latest changes in the correct folder. The doc control software also gives us access to previous versions of said program as far back as initial creation. By saving each changed version of a program into doc control has saved me many a time when someone made changes without going through doc control.

Children
No Data
© 2024 Hexagon AB and/or its subsidiaries. Privacy Policy | Cloud Services Agreement