This week's book giveaway is in the Agile and Other Processes forum.
We're giving away four copies of The Little Book of Impediments (e-book only) and have Tom Perry on-line!
See this thread for details.
Win a copy of The Little Book of Impediments (e-book only) this week in the Agile and Other Processes forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

How to document the PART 2

 
James Wang
Ranch Hand
Posts: 102
  • Mark post as helpful
  • send pies
  • 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?
 
H. Hafer
Ranch Hand
Posts: 108
  • Mark post as helpful
  • send pies
  • 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
 
D. Rose
Ranch Hand
Posts: 215
  • Mark post as helpful
  • send pies
  • 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
  • Quote
  • Report post to moderator
Harbo,D. Rose

Thank you very much!!!
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic