The need for proper documentation of such efforts does not end there, however. It is very important, especially for more complex sets of rules, that there be clear documentation of the purpose and logic of the rules developed, and that this documentation be present
- in the rules themselves (as comments) and
- in external documents to be used as references for troubleshooting, maintenance and further development.
|Excerpt from a large set of currency format rules with extensive comments. These comments are stripped when
the rules are imported into memoQ, so all maintenance should be done externally in a tool like Notepad++.
|Click to access a PDF sample of my rule development record (2 pages)
- descriptions of all information recorded
- a specific example on which I will base the general rule
- a simple ("fragile") version of the rule part (source input and target output) with only the most essential elements; this is not error-tolerant, but it is the easiest to understand and the first place to look if something isn't working as I would like it to
- more robust variations which take into account differences in spacing, punctuation, etc. or include things like non-breaking spaces that might be desired in the output (this can get cluttered and hard to read)
- color-marking for easier identification of some elements
- comments about why things are written as they are or about possible improvements or problems