Apart from learning a new language, don't forget that you are leaving your workmates, and those who follow them, a long term code maintenance burden. Even if they learn Perl well, they may struggle to trouble-shoot production problems with your code, especially if they must be fixed urgently. Accordingly, you should consider what you can do to help them.
- Documentation. Make sure all your programs and modules are well-documented. Clear usage help (-h), with examples, for all commands in your suite is essential. I further suggest a comment block at the top of every large component explaining the background, intent, rationale, external references, etc.
- Logging/tracing. If you have not done so already, you should consider adding a logging facility to your programs. When trouble-shooting a production problem, or just to help understand how the program works, your workmates could then run your script (with a verbose flag, say) and it will spit out what it is doing in detail at each step, helping both in trouble-shooting and understanding how it works.
- Testability. When the new guys make a change to your code, how are they going to test it? You need to plan for this. If you already have a test suite, you could ask them, as a training exercise, to write some new tests.
Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
Read Where should I post X? if you're not absolutely sure you're posting in the right place.
Please read these before you post! —
Posts may use any of the Perl Monks Approved HTML tags:
You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
- a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
Link using PerlMonks shortcuts! What shortcuts can I use for linking?
See Writeup Formatting Tips and other pages linked from there for more info.
| & || & |
| < || < |
| > || > |
| [ || [ |
| ] || ] ||