professional writing at purdue university

Navigation

User login

Who's online

There are currently 0 users and 7 guests online.

 











 

 

Comments Tutorial

PaulKlinker @ Fri, 09/17/2004 - 18:03

Project:OSDDP Site
Component:Documentation
Category:task
Priority:normal
Assigned:PaulKlinker
Status:active

Description

Step by step instructions on how to post and update a comment on the site. Also will include picture steps for usability.

Updates

#1 submitted by PaulKlinker on Wed, 09/22/2004 - 17:34

Project Group:
Chris
Jody
Paul

#2 submitted by jwample1 on Fri, 10/01/2004 - 17:53

I am adding the documentation plan.

#5 submitted by PaulKlinker on Fri, 10/29/2004 - 17:33
Attachment:TASK LIST_Project 3.doc (24.5 KB)
#6 submitted by PaulKlinker on Fri, 10/29/2004 - 17:44
Attachment:TASK LIST_Project 3_revised.doc (25.5 KB)
#7 submitted by PaulKlinker on Wed, 11/03/2004 - 15:09
Title:Tutorial on how to post a comment» Gantt Chart: Project 3
Attachment:Gantt Chart Project 3.xls (18.5 KB)
#9 submitted by suzanne on Wed, 11/10/2004 - 16:52
Title:Gantt Chart: Project 3» Comments Tutorial
#10 submitted by mj101984 on Fri, 12/03/2004 - 17:44

Here is a link to our documentation: http://web.ics.purdue.edu/~bettena/tutorial.html

Comment viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.
 
Wed, 12/08/2004 - 16:07
 

This is only a test

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

I really like how you put the documentation together. It helps to put pictures in to actually show what to do. Nice, but I do agree with switching how to create a comment and edit a comment. The create a comment should come first.

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

first of all, why would you teach people how to edit a comment before showing them how to create the comment?

otherwise it looks good

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

This is a test comment that is modified

login to post comments
 
Fri, 11/19/2004 - 15:33
 

This is only a test.

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

progress report looks good. i could nt find the gantt chart.

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

good job. very thorough

login to post comments
 
Wed, 11/10/2004 - 17:51
 

Integrating your gantt chart into your progress report would be helpful to readers. It gives them an idea of the timeframe you're working with.

login to post comments
 
Wed, 11/03/2004 - 16:47
 

Good start. I like the sans-serif font, which makes it look crisp and easy to read.

I would suggest:
(1) adding a title
(2) making the tasks grammatically parallel
(3) adding a column that specifies who is assigned to what task (unless you are all working on all of them?)

login to post comments
 
Mon, 11/01/2004 - 18:14
 

The task list looks good. It is very thorough and indepth. If this is followed I believe that the final product will be an asset to the website.

login to post comments
 
Fri, 10/29/2004 - 17:41
 

could have a step that shows your actual work on the project not just the drafting of the documents for class.

login to post comments
 
Wed, 11/03/2004 - 16:43
 

Clint, what (more specifically) do you have in mind? I'm not sure exactly what you mean, but since you usually have great peer-editing suggestions, this idea is probably worth pursuing.

Paul, Adam, Curt and Maurice-- you have a typo in 4d, and you might want to follow up with Clint, but otherwise this list looks really good. I think it will be easy to follow.

p.s. After looking at your Gantt chart, I suggest adding the progress report to the task list, so that the two documents match (which will make for greater clarity).

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

I think this task list is definitely on the right track. For your project, it makes sense to lay out the tasks associated with writing the tutorial itself (or, in other words, project 3 rather than project 2). And you do that here.

Another strength of the task list are the first and last steps: you get people to the OSDDP and you get them logged off at the end.

Step 6 is great! It gets the user interacting with the site and the rating feature is a fantastic idea; it will give us some good usability data.

Finally, I like the heirarchy of steps and substeps-- you have a lot of information here but your list isn't so long that it's overwhelming.

Some suggestions:
I'm not sure if/ why step 4 is necessary-- is there anywhere on the OSDDP where you have to specify your user type?

Steps 2-4 seem like part of the final documentation itself than the tasks you will need to document (which are in step 5). You may want to edit this part so that it focuses on the tasks necessary to create (rather than use) the tutorial.

Finally, the tutorial probably should be free-standing or part of the user's guide rather than embedded in a single issue. That's because you can post a comment on any issue in the site-- and also older issues tend to get moved to the later pages and so are harder to find.

login to post comments
 
Sun, 10/03/2004 - 21:02
 

This is a test to see how the comment function works

login to post comments
 
Mon, 10/04/2004 - 21:11
 

This is a clear and well-designed plan. I just have a few minor suggestions.

1. Write out the group members' qualifications in paragraph form. I think it just looks a little more persuasive that way.

2. Should the resources section be fleshed out a bit to be more specific about which computer resources?

3. Consider adding a line to the schedule about learning/experimenting with the comment feature (esp. since it looks like Paul has already done that). You're right to say that it's hard to know if you've discovered all of its functionality, but you also want to show off your knowledge of your topic.

Aside from those rhetorical tweaks, it looks very good.
Suzanne

login to post comments