ToDo

These best-practice examples and the according documentation are on ongoing effort in providing best material for learning software engineering techniques. As such, neither the examples nor the documentation will be ever "finished". As a team, we want to be transparent about open issues and problems we are aware of, and also show, what we are currently working on.

In case you find any problems, or you have ideas how to improve this project, please contact us and help us adding important point to this todo list.

Architecture

  • ER Diagram of Data-model
  • Brief UML introduction?
  • Architecture Sketch: Extend with information what is learned on each step

Java Examples

  • new SqlParameter("matnr", Types.VARCHAR));
  • Check Unit tests, particularly the DAO Tests in Basic are partly nonsens.
  • Describe how to start the example applications, probably create start scripts.
    • is actually Spring 2.0m4 required or can it be changed to 2.0
    • Medium Examples: no versions are provided for Hibernate...
  • Add i18n to example!
  • Add iBatis as alternative persistence technology to Hibernate
  • Refactor Packages to remove all "SE1" and related names.
  • Refactor: Interfaces should not start with I; e.g.: IStudentDAO to StudentDAO
  • Check Javadoc comments Basic: JdbcObjectStudentDAO; partly missing, partly wrong

Technologies

  • Add i18n, resource bundles
  • Still missing:
    • AOP with declarative transactions
    • Security with AOP
    • Spring ORM/Remote
  • Check Tomcat documentation

Maven

  • Create on documentation section: In this section explain (overview) how to generate a complete project documentation with Maven including:
    • Project Meta-information
    • Javadoc
    • Program documentation
    • Unit-test results

New Features

  • Add a section to the documentation explaining the most important "groupeware" tools like SVN, bugtracking, ...