Create detailed records of your overrides in an external file
Keep a record of your overrides in an external file, such as a txt file or spreadsheet, that lists which files you changed and include a brief description of the changes that you made. Store this file along with your project and print it out the next time you upgrade ePublisher to help you remember what files you changed and what changes you made.
I like to include information about why overrides were created, what targets are affected, where I found information about the override, and any other comments about the override that I might need to know in the future. In addition, when I no longer need an override, I still keep the information about it with a note about when I removed the override and why.
REMEMBER : A detailed record should not replace commenting your code changes. Always comment your code changes within your override files.
It might not always be possible to maintain such a detailed list of your overrides because it takes time to complete; however, knowing what has changed, where, and why will be invaluable to you when you upgrade your version of ePublisher, and to other people when they take over your project.
Published date: 10-17-2023
Last modified date: 09-28-2023