professional writing at purdue university

Navigation

User login

Who's online

There are currently 0 users and 8 guests online.

 











 

 

Third Draft of Documentation Plan

smith84 @ Wed, 09/22/2004 - 17:42

Project:OSDDP Site
Component:Documentation
Category:support
Priority:normal
Assigned:smith84
Status:active

Description

Mark and Kevin will be updating the glossary users guide for the Engl. 421 OSDDP website project #2.

Updates

#1 submitted by mdrelich on Wed, 09/22/2004 - 18:10

Currently we are working on our documentation plan and should be completed with it by monday.

#2 submitted by mdrelich on Fri, 10/01/2004 - 17:51

Linked is a copy of our final documentation plan

#3 submitted by mdrelich on Fri, 10/01/2004 - 17:58

Posted is a copy of our Powerpoint task list. Enjoy!

#4 submitted by smith84 on Fri, 10/08/2004 - 17:34
Attachment:Documentation Plan_0_0.doc (21.5 KB)

Here is our final submission for Project 2

#5 submitted by smith84 on Fri, 10/08/2004 - 17:42
Attachment:task list.ppt (23.5 KB)

Here is our final submission for the Task List for Project 2

#6 submitted by smith84 on Fri, 10/08/2004 - 17:43
Attachment:storyboard=113&mime=57d6112a4b401fb2f35179b3528e53c5.ppt (128.5 KB)

Here is our story board for Project 2

#7 submitted by mdrelich on Fri, 10/29/2004 - 17:44
Title:Create a simple Glossary users guide» Project 3 Glossary Update
Attachment:Task List Proj 3.doc (31.5 KB)

Attached is our updated task list for project 3

#8 submitted by jwample1 on Mon, 11/01/2004 - 18:06
Title:Project 3 Glossary Update» New Task List
Attachment:Proj.3 task list.doc (24.5 KB)

Here is a revised task list.

#9 submitted by jwample1 on Mon, 11/01/2004 - 18:07
Title:New Task List» Gantt Chart
Attachment:gantt chart.xls (17 KB)

Here is our Gantt chart.

#10 submitted by jwample1 on Wed, 11/03/2004 - 17:33
Attachment:gantt chart_0.xls (17 KB)

Here is gantt chart. Is the format better? I deleted the blank space at the top of the page.

#11 submitted by jwample1 on Wed, 11/03/2004 - 17:58
Attachment:gantt chart_1.xls (17 KB)

I deleted some more blank space.

#12 submitted by jwample1 on Wed, 11/10/2004 - 17:37
Title:Gantt Chart» Progress Report
Attachment:progress report.doc (77 KB)

Here is our progress report as of 11/10/04.

#13 submitted by jwample1 on Fri, 11/12/2004 - 17:51
Title:Progress Report» New Progress Report
Attachment:progress report_0.doc (78 KB)

Updated progress report

#14 submitted by mdrelich on Fri, 11/19/2004 - 18:06
Title:New Progress Report» Rough Draft of Documentation Plan
Attachment:Glossary terms.doc (26.5 KB)

Attached is the rough copy of our documentation plan. Enjoy!

#15 submitted by jwample1 on Mon, 11/22/2004 - 18:17
Title:Rough Draft of Documentation Plan» Second Draft of Documentation Plan
Attachment:Glossary terms_0.doc (28 KB)

Here is our second draft.

#16 submitted by jwample1 on Fri, 12/03/2004 - 18:09
Title:Second Draft of Documentation Plan» Third Draft of Documentation Plan
Attachment:documentation plan.doc (29 KB)

Here is our 3rd draft.

Comment viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.
 
Mon, 12/06/2004 - 13:44
 

All of the words that were defined thus far are usefull. The recommendations for improvements is also clear and well thought out. As with any glossary, the more words the better. Otherwise, it reports what would be expected.

login to post comments
 
Mon, 12/06/2004 - 15:07
 

"As with any glossary, the more words the better."

I think Paul has a point here. What about explaining the "news aggregator"? Or possibly distinguishing a project from an issue, if we can figure that out ;)

login to post comments
 
Fri, 12/03/2004 - 18:02
 

The document is clear and easy to read. The suggestions in the study are nice also. However, I would suggest using different terminology for "cyberspace junkies" :).

login to post comments
 
Fri, 12/03/2004 - 17:58
 

This looks good to me. I am glad you have added more words to this site. It helps people like me out! The definitions look good and clear.

login to post comments
 
Fri, 12/03/2004 - 17:56
 

looks good, short and to the point, no fluff

login to post comments
 
Mon, 11/22/2004 - 18:00
 

I'm glad that the glossary issue is being addressed. There are certainly several words that could be added to this section which your group has addressed very well.

login to post comments
 
Mon, 11/22/2004 - 17:52
 

The progress report looks good. I like the idea of keeping the glossary format to ‘textbook simplicity.’

login to post comments
 
Mon, 11/22/2004 - 17:50
 

one improvement i have noticed is that your gantt chart has all the tasks divided up but it would be easier to understand if you made a list of what the individual tasks were.

login to post comments
 
Mon, 11/22/2004 - 17:44
 

The idea of defining each glossary term is good. The outline is brief but well explained. It seems like you guys are on right track.

login to post comments
 
Fri, 11/19/2004 - 22:35
 

I like the idea of adding words to the glossary. That puts the total count up to about 10 words now. Also, you had some good ideas for the site and its glossary.

login to post comments
 
Wed, 11/10/2004 - 18:12
 

looks good

login to post comments
 
Mon, 11/01/2004 - 16:55
 

Creatively designed and you have a lot of good planning steps. I also like how specific you are about your research methods.

Two questions or suggestions:
1. Where do you actually draft the definitions of the terms in the glossary? Maybe include that somewhere.

2. I'm not exactly sure what Kevin's role as "Secretary of visuals" entails.

login to post comments
 
Fri, 11/05/2004 - 02:02
 

I like how you have integrated the schedule and the tasklist. This document looks like a helpful project management tool-- you can all tell what you're supposed to be doing on week X.

I do advise adding the progress report. My apologies for overlooking that before.

login to post comments
 
Wed, 11/03/2004 - 17:02
 

Looks good. Maybe take out some of the empty rows up top so that one doesn't have to scroll down to see your legend.

login to post comments
 
Fri, 11/05/2004 - 01:55
 

Very nice. In particular, I approve of Jody's logical file naming procedure. I'm assuming the numbered tasks match those on your task list? Possibly doublecheck that.

Actually, you could even move the legend down a row or two. Obviously I am now getting into the realm of Very Small Suggestions...

login to post comments
 
Wed, 10/06/2004 - 15:25
 

Looks good! Here are a few ideas:

1. If we're going to mix up the groups between project 2 and project 3, maybe "Team Member 1" and "Team Member 2" makes more sense than "Mark" and "Kevin." By the way, Kevin's name is in a bigger font than Mark's-- not a big deal, but perhaps Mark would prefer you be equal :).

2. It seems to me that there are some tasks the two of you could do independently at the same time (for example, in your third column-- Ask Self Questions About Functionality & Research Other Glossaries) and others that have to be done in sequence, such as in the second column. Maybe number your boxes to clarify that.

login to post comments
 
Mon, 10/04/2004 - 20:56
 

Mark and Kevin,
I really like the clarity of your plan. You explain logically why you want to work on the glossary and you have specific goals in mind ("We want everyone [...] to be able to see the glossary tab in a menu bar, click on it, and then scroll down to the word they are trying to find.").

Suggestions:
1. In the sentence on other documentation, the sentence about the search function feels kind of stuck in there-- you may need a transitional word or phrase.

2. Since you say that you're having trouble finding helpful information, maybe look for other glossaries related to the open source movement. Here's one I found informative:
http://www.netrino.com/Articles/OpenSource/

Good luck--
Suzanne

login to post comments