Internship general details

From Inforail
(Redirected from General details)
Jump to: navigation, search

The development process

  • Spend some time devising a plan before you do any actual programming
  • Define the project's work breakdown structure (WBS) [1]
  • Build a table of activities (or items in of the WBS) and specify the following:
    • name
    • description
    • estimated time of completion
    • actual time of completion
    • the number of bugs found
    • conclusions
  • Document all your activities, enabling other people to understand what you are working on
    • The minimal requirement is to have a readme.txt with a general description of what the code does and how it does it
    • Add flowcharts or diagrams if the project's complexity requires that
    • Add relevant comments inside the source code itself (see coding guidelines below)
  • Follow the coding guidelines when writing code