• 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

How to document the PART 2

 
Ranch Hand
Posts: 102
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Hi ALL,

how to document the part 2, which aspect should I describe it from? I should illuminate each usecase or each diagram or others? now I dont know how to begin it. can you help me?
 
Ranch Hand
Posts: 108
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
The very first things are the diagrams the assignment demands. So try to begin with them first.
You will notice that you will have to make assumptions for your decisions. Write them down somewhere - all of them!
After you've finished the diagrams you should compile a text file in which you explain your assumptions. You can do it in one monolithic file or per diagram, thats your choice. Then render it in HTML and upload it. That's all!

HTH,
Harbo
 
Ranch Hand
Posts: 215
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
The main parts of the document would be

1. Explaining of your assumptions
2. Your over all architecture and the choices you made. Also explain how your architecture meets the specified requirements.
3. Required diagrams

I prefer HTML document with links to diagrams rather than one monolithic file. That way it is easier to browse.
 
James Wang
Ranch Hand
Posts: 102
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Harbo,D. Rose

Thank you very much!!!
 
reply
    Bookmark Topic Watch Topic
  • New Topic