ETWR 2477: Documentation Process and Content Management (Online)
The following provides an overview of this course, its objectives, policies, grading plan, and other information about the course.
Note: This is the only the second time this course is being offered. I will make every effort to ensure that your workload is reasonable; that expectations, assignments, and due dates are clearly defined; and that this course becomes very important in your career.
Working in teams and documenting simple tasks, you will take a documentation project from competitive proposal straight through to completion, moving through important phases such as team building, initial proposal, documentation plan, scheduling, prototypes, style guide, drafts, edits, revisions, and final deliverables.
This course will include as much of the following as we can arrange:
- Study the traditional phases of an information development project.
- Work in teams to design, create, and format a document.
- Take a documentation project from competitive proposal straight through to completion, moving through important phases such as initial proposal, team building, documentation plan, scheduling, prototypes, style notes, drafts, edits, revisions, and finished deliverables.
- Assume typical team roles such as coordinator, writers, editors, and graphics specialists.
Upon completion of this course, student will be able to do the following:
- Describe in writing the essential phases and deliverables of the documentation process as well as the key roles in the documentation process, including planner, coordinator, writer, editor, peer reviewer, and graphic designer.
- Describe in writing the purpose, content, and organization of key document in the documentation process, including proposal, plan, style notes, prototype, templates, review summaries, and drafts.
- Function effectively as a documentation-team member to produce a document that meets the standards of good writing and good document design and that is completed on schedule.
- Produce guide nformation that documents team rules and roles and that facilitates the team project.
- Produce competent proposal, plans, style guides, prototypes, templates, review summaries, and interim drafts of a team-documentation project.
These are required:
- JoAnn T. Hackos. Information Development: Managing Your Documentation Projects, Portfolio, and People. Wiley.
- JoAnn T. Hackos. Content Management for Dynamic Web Delivery. Wiley.
You will also have access to a reserve copies of the following:
- JoAnn Hackos's Managing Your Documentation Projects. Wiley. We'll be reading about 100 pages from it.
- Sun Technical Pubs. Read Me First!. 2nd ed. Prentice Hall. We'll be reading Appendix A on teams, roles, processes.
- David McMurrey. Power Tools for Technical Communication. Heinle. We'll be reading chapter 22 on teams.
Your final grade will be based on the following:
|Individual blog (includes self-introduction, summaries, comments)
|Project proposal (team)
|Tracking document (team)
|Information plan (team)
|Team blog (includes team roles and rules, task assignments and dates, style notes, and post mortem)
|Final project (team)
Here is a description of these units:
As you can from the above, there are numerous question marks about exactly what we will do in relation to each of the topics to be covered in this course.
- Participation. Plan to attend online meetings. They may not be every week; in some cases, there may be more than one in a given week. If you have questions or just want to discuss current course topics, use the class e-mail link on the schedule page. If you cannot attend the meeting, you can review the recording of it. To get credit for the meeting, summarize the key points in the meeting, and send them to me by e-mail.
- Team meetings. In this course, you are not expected to meet face to face in person with your team member; in fact, it's preferable to find online methods to meeting.
- Team problems. Teams can have obvious problems such as one team member hogging all the work, another doing nothing, another being abrasive and difficult, another being shy and noncommittal. Try to handle these problems within your team, confront problem up front. Worst case, ask for resolution from your instructor.
- Plagiarism. Plagiarism means using other people's work as if it were your own. In this course, it also means having someone write or edit your work for you. Plagiarism is unethical and will not be tolerated. If I detect plagiarism on any of your assignments, you will receive a zero for your grade. More than one instance of plagiarism will result in a failing grade for the course.
- Production of documents. Because this is a team-based online course, you will need to produce documents in the wiki site or in something like Google Docs. You will need to use check-in and check-out functions to prevent two or more people from editing a document at the same time.
- Use of computer hardware and software. You need not own a computer or have word-processing software such as Word, WordPerfect, PageMaker, FrameMaker. However, you will be expected to learn the basics of a wiki and a project management system. Tutorials will be provided.
- Computer knowledge. You do not need to have anything more than a general end-user familiarity with computers and the Internet to do well in this course.
- Disabilities. Students needing an alternate mode of instruction, performance, or testing should contact the instructor about these needs in the first week of the semester.
Information and programs developed by email@example.com.