14 Documentation

All VYA modules should be accompanied by a document that contains at least the following, as this is important for their re-usability:

1. Introduction

• brief outline of function; mention of existing implementations, e.g., IC type number

2. Feature list

• overview list of all features (data book style)

3. Algorithm

• brief description of algorithm; use references for more detail

4. System overview

• partitioning of module into processes
• fifo names (input, output, internal)
• indication of memories

5. Performance

• image quality
• compute resources (execution speed, memory usage)

6. Interface

• video I/O: data type, port names, token size, data rate, image sizes
• control: data rate, type (user control vs. system control)

7. Future work

• suggestions and recommendations, e.g., for algorithmic improvements

8. References

Appendix A. code structure

• list of directories and files

Appendix B. example

• brief description of the example system supplied with the module, including block diagram and test sequence(s)