Hi Billy I did the old Fly By Night Services assignment, and in that we were allowed to submit the design decisions in any format we liked. So mine was in HTML, and my UML application allowed me to export all my class diagrams as JPG files, so I included them. I do recall one person here including text class diagrams. This is not very difficult: But I think most people dont bother with class diagrams. Regards, Andrew

Billy Tsai
Ranch Hand

Joined: May 23, 2003
Posts: 1304

posted Jun 24, 2003 16:06:00

0

can I use notepad in windows to write choices.txt and version.txt because I dont know how to put diagram in there with notepad? how many pages did you guys wrote? and how did you determine the number of pages u wrote

Hi Billy Yes, you can use notepad to write your documentation. All you need to ensure is that the files that Sun tells you must be in text format are in text format - Notepad will save your files in Microsoft text format, so you are safe. Don't get stressed about diagrams. You dont need them. If you do want to add them, then take a look at how I did the MVC diagram above - that is just plain text. I normally do not care about counting lines of code, or numbers of classes, or numbers of pages of documentation. To me: once the documentation is clear, it is complete. I don't care if it is twice as many pages as someone else, or half the pages of someone else. The exception of course, is when writing something that has a fixed word limit. However since you asked, I will try and count them [andrewm@andrewm scjd]$ wc -l README.txt 414 README.txt [andrewm@andrewm scjd]$ echo $((414/66)) 6 So, assuming 66 lines per page, we get 6 pages for my README.txt file. My DesignChoices.html file was in html format (we were allowed this in the old assignment). Loading that into my word processor shows 11 pages. My user documentation totalled 19 pages (roughly 2 pages for each major screen, plus additional pages for modules as a whole). Also in html format. By the way, I am constantly accused of writing too much (just look at how long any of my posts are ) Regards, Andrew

My choices.txt ended up at about 15 pages. I write too much too. I know people have passed with just a couple of pages.

I organized my file differently, however. I chose, out of sheer paranoia, like much else I did in my assignment, to follow the instructions exactly. So where it says, in my Bodgitt and Scarper instructions

"Detail the problems you perceived, the issues surrounding them, your value judgments, and the decisions that you made. This document should also describe any uncertainties you had regarding the project, and the decisions you made when resolving them."...

I organized my file differently, however. I chose, out of sheer paranoia, like much else I did in my assignment, to follow the instructions exactly. So where it says, in my Bodgitt and Scarper instructions

Very wise decision.

Vikas and I were both working on the Fly By Night Services assignment, which has different documentation requirements than the current (URLyBird and Bodgitt & Scarper) assignments.