Project Documentation

0 views
Skip to first unread message

naweednr

unread,
Feb 13, 2009, 10:27:19 PM2/13/09
to UCOOP
Dear All
I've uploaded the project documentation and User manual in files
section, please every one have a look as soon as possible and let me
know if anything needs to be changed? (Its not totally completed ) so
I can finalize it soon and submit it.
Noor Mohammad and Ibrahim are working on developer manual (API) but
its not finished yet!
Regards

freshta popalyar

unread,
Feb 14, 2009, 5:56:28 AM2/14/09
to uc...@googlegroups.com
Salam Naweed

The documentation is written very nicely and with good English, but I found some small structure mistakes which I have marked for you.
I have made some changes in Red and Green colors in the documentation, where Red means an error or unnecessary lines of texts and Green means changes that I suggest that should be added in the document, so that you can adopt them if you agree.
One point should be noted that if you take care of structure of your document from the beginning (heading 1,2,3,...) this will be very easy for you in the end to make table of contents, also easier for the reader to understand parts and sections of the document.

with regards
Freshta


From: naweednr <nawe...@googlemail.com>
To: UCOOP <uc...@googlegroups.com>
Sent: Saturday, February 14, 2009 4:27:19 AM
Subject: [ucoop] Project Documentation
UcoopDocChangedByFreshta.doc

naweed rahmani

unread,
Feb 14, 2009, 9:15:26 AM2/14/09
to uc...@googlegroups.com
Salaam Freshta
Thank you very much for your help and remarks on Documentation, I found it really useful, so i've brought changes according to, and refined the project documentation so please have a look once again if any part is missing, or still mistakes. :)

Dear All
please have look on attached PDF and ODT documents that we could decide it good enough to submit.
Regards
UcoopDoc.odt
UcoopDoc.pdf

Shafi Tokhi

unread,
Feb 14, 2009, 9:23:50 AM2/14/09
to uc...@googlegroups.com
Dear Naweed,
Thanks for the nice work, The wiki link in the documentation requires authentication, its good if you put the content of wiki in the documentation itself.
 And please do not forget to check the spelling and grammar errors in documentation by the word processor.

A questions for the whole group:
What do you think is it necessary to put the Scenario and detailed use case diagram in the documentation or not?

Regards,
--
Shafi tokhi

Haji Gul Wahaj

unread,
Feb 14, 2009, 9:36:10 AM2/14/09
to uc...@googlegroups.com
Salam,

I think it is necessary to be putted because it is a part of documentation.

kind regards,

wahaj
 

====================

Haji Gul    Wahaj
Berlin,   Germany

Mobile No: 0049 1577 6307404
wa...@cs.tu-berlin.de
Skype: hajigul_2
                 




From: Shafi Tokhi <shafi...@gmail.com>
To: uc...@googlegroups.com
Sent: Saturday, February 14, 2009 3:23:50 PM
Subject: [ucoop] Re: Project Documentation

mohammad ismail

unread,
Feb 14, 2009, 10:20:20 AM2/14/09
to uc...@googlegroups.com
Dear Members,

in my point of view every one can see Scenario,class diagram, sequence diagram, use case diagram and it,s details but state chart,packages may be some other are not important to see customers or readers, because it,s just for developers.
it will be better that we put scenario and use case details in documentation part.
thanks
ismail

freshta popalyar

unread,
Feb 14, 2009, 11:14:02 AM2/14/09
to uc...@googlegroups.com
salam,

I think its important to put all our work in documentation, because this documentation is not for customers or end users but, this is a documentation for those who will read it and do any further improvements in it, and also not to forget its for our teachers.

regards
Freshta


From: mohammad ismail <ismail4...@gmail.com>
To: uc...@googlegroups.com
Sent: Saturday, February 14, 2009 4:20:20 PM

Subject: [ucoop] Re: Project Documentation

Tanha Sherzad

unread,
Feb 14, 2009, 11:17:24 AM2/14/09
to uc...@googlegroups.com
Salam,
It would be nice to include them as well, because the lecturers should realize how we started our project and how did it

Regards,

freshta popalyar

unread,
Feb 14, 2009, 12:19:00 PM2/14/09
to uc...@googlegroups.com
Salam Naweed

You are welcome. I looked at it once again, now it looks finner.
One more remark i have and that is about the format of document. I mean the level of headings should have the same font and size. And also the number of blank lines that you want to put after each paragraph should be the same in all document. And there is one paragraph which has the title of "NOTE" I think its not related to documentation or is it?


From: naweed rahmani <nawe...@googlemail.com>
To: uc...@googlegroups.com
Sent: Saturday, February 14, 2009 3:15:26 PM
Subject: [ucoop] Project Documentation
Reply all
Reply to author
Forward
0 new messages