• Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other Pie Elite all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Jeanne Boyarsky
  • Ron McLeod
  • Paul Clapham
  • Liutauras Vilda
Sheriffs:
  • paul wheaton
  • Rob Spoor
  • Devaka Cooray
Saloon Keepers:
  • Stephan van Hulst
  • Tim Holloway
  • Carey Brown
  • Frits Walraven
  • Tim Moores
Bartenders:
  • Mikalai Zaikin

Minimum doc's you'd need to understand a Progarm

 
Ranch Hand
Posts: 43
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
I'm helping in an insource of a project and am wondering if other expert java guru's out there had a list of the required documents that you'd want from the outsourced team.

I'm thinking beyond just UML, but into documents that you figure would be vital to the insource. I have documents like:

Database schema
Source Code overview -> Which I"m not even sure what this would contain yet
Package Structure Overview
Code Conventions
Deployment Process
Library Dependancies
Testing -> ?


I know that's just the tip of the iceberg, any good suggestions on people who have had to do similar projects? Best practices?

Note: I'm not sure if this is the right area for this, but there wasn't a good place I could place this thread.
 
Bartender
Posts: 1638
IntelliJ IDE MySQL Database Java
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
The closest forum for this topic according to me is "Agile & Other processes" (Reasoning: It is more of a process related question i guess), but , it is not definitely what we discuss in Java - Advanced.
Moving ...
 
Ranch Hand
Posts: 1855
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
How about the following documents:

  • a user guide
  • a programmer guide
  • an administration guide
  • an installation guide


  •  
    Don't get me started about those stupid light bulbs.
    reply
      Bookmark Topic Watch Topic
    • New Topic