0% found this document useful (0 votes)
21 views11 pages

Tech Writing

Wgu Tech Writing

Uploaded by

egb893
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
21 views11 pages

Tech Writing

Wgu Tech Writing

Uploaded by

egb893
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

TWA1 - Technical Writing

Course of Study

This course supports the assessment for TWA1. The course covers 1 competency and represents
4 competency units.

Introduction
Overview
The fact that you are here, working on technical writing, means that you are very close
to completing the requirements of your degree. That is indeed good news! At the completion of this
assessment, you will have a technically written proposal in hand, so this assessment is actually the
first step in your final approach to graduation.

Most information technology projects begin with a formal proposal, and this course will give you
experience in creating one. Formal proposals generally include requirements, a summary, a
description of how requirements are met and how the project will be managed, cost analysis, and
implementation plans and schedules. Putting together a document like this will draw on many of the
competencies that you acquired during the course of your program, and you will probably see some
of those competencies in a new light.

At the end of it all, you will experience the satisfaction of knowing how it feels to enter a project well
prepared. You may find yourself wanting to be thorough in your personal planning as well.
Thorough planning makes for well-informed decisions and actions, and that is a key to business
success.

Competencies
This course provides guidance to help you demonstrate the following 1 competency:

Competency 405.2.1: Project Proposal


The graduate prepares a project proposal according to the guidelines specified in the
program guide.

Course Mentor Assistance


As you prepare to successfully demonstrate competency in this subject, remember that course
mentors stand ready to help you reach your educational goals. As subject matter experts, mentors
enjoy and take pride in helping students become reflective learners, problem solvers, and critical
thinkers. Course mentors are excited to hear from you and eager to work with you.

Successful students report that working with a course mentor is the key to their success. Course
mentors are able to share tips on approaches, tools, and skills that can help you apply the content
you're studying. They also provide guidance in assessment preparation strategies and troubleshoot
areas of deficiency. Even if things don't work out on your first try, course mentors act as a support
system to guide you through the revision process. You should expect to work with course mentors
for the duration of your coursework, so you are welcome to contact them as soon as you begin.
Course mentors are fully committed to your success!

1/11
TWA1 - Technical Writing
Course of Study

Preparing for Success


The information in this section is provided to detail the resources available for you to use as you
complete this course.

The Preliminaries
There are just a few things to do before you begin the actual work of getting your proposal together.
These activities are simple, and should not take much time. They are, however, very important.

Other Learning Resources

You will use the following learning resources for this course.

APA Formatting With Purdue OWL


Successful completion of this course requires an understanding and application of proper APA
formatting. Please review the Purdue OWL APA Formatting and Style Guide for formatting
guidelines and solutions for a range of citation types. If you find yourself in need of additional
information on APA formatting, you are welcome to purchase a copy of the most recent edition of
the Publication Manual of the American Psychological Association at your own expense.

Additional Preparations

Schedule Planning Checklist


The technical writing assessment is complex. Consequently, a plan with milestones is invaluable to
keep you on track to finish within a reasonable timeframe.

Schedule Planning Checklist Template [XLS]

A schedule planning checklist has been provided for you. Fill it out and send it to your mentor, who
will monitor your progress to help you stay on track. As you work your way through the
assessment, send an updated checklist to your mentor every week.

Technical Writing Template


To make life a little easier for you, there is a technical writing template available for you to
download to help you build your final technical writing report.

Technical Writing Template [DOC]

Pacing Guide
The pacing guide suggests a weekly structure to pace your completion of learning activities. It is
provided as a suggestion and does not represent a mandatory schedule. Follow the pacing guide
carefully to complete the course in the suggested timeframe.

2/11
TWA1 - Technical Writing
Course of Study

Pacing Guide: Technical Writing

Note: This pacing guide does not replace the course. Please continue to refer to the course for a
comprehensive list of the resources and activities.

Technical Writing Competency Development Phase


It is difficult to prescribe a learning path through this phase because students enter with a variety of
backgrounds. Is yours heavy on the technical side but light on user communication? Or do you
write well but lack an understanding of technical issues? The ability to produce clear technical
communication is an important skill; it is hard to find an IT job description that does not mention the
desire for coherent communication ability. Take the time now to reinforce your previously-acquired
competencies and develop them further.

Starting the Process


Where do you start? Where is the beginning? The start of a project can seem overwhelming
because it is not always clear where to begin. This topic suggests two things to help you get a
handle on what must be done and how to do it:

1. Participate in the Technical Writing Subject Area Message Board.


2. Review the Purdue OWL APA Formatting and Style Guide

Participating in the Message Board

You should not underestimate the value of collaboration with the technical writing subject area
mentor and with other students who are working on this assessment. The heart of this feature is the
course message board. Use it to initiate, focus, and refine your ideas. Get help with things outside
your expertise. Your fellow students have a variety of backgrounds, and someone can help.

Reviewing the Purdue OWL APA Formatting and Style Guide

First, read the grading rubric for the TWA1 assessment in TaskStream. The technical writing
assessment rubric is based on the APA style. You should be familiar with APA style for your task
as well, too. Visit the following website to review APA style:

Purdue OWL APA Formatting and Style Guide

Focus your attention on learning manuscript structure and content and on writing clearly and
concisely.

A search on the Internet will locate numerous other resources that will help you prepare your
proposal so that it meets these important requirements.

3/11
TWA1 - Technical Writing
Course of Study

Capstone Project Waiver or Release Statement/Authorization to Use Restricted


Information

It is the policy of Western Governors University ("WGU") that student Capstone projects should not
be based upon, and should not include, any proprietary or classified information or material
belonging to your employer or any other organization ("Restricted Information") without appropriate
authorization.

Students are required to complete the IT Capstone Waiver-Release Form when submitting any
Capstone work and declare one of the following:

A. The Capstone is not based upon and does not include Restricted Information.

Or

B. Capstone project is based upon and/or includes Restricted Information.

IT Capstone Waiver- Release Form

If the Capstone project is based upon and/or includes Restricted Information, students are required
to obtain authorization to use restricted information and must have the IT Capstone Employer
Release Template completed when submitting any Capstone work.

IT Capstone Employer Release Template

Failure to submit the appropriate documentation along with your Capstone work will result in a
returned submission.

Technical Project Topic Definition Phase


It is time to decide on a topic for your technical project and turn it into a proposal. In some respects,
this is the hardest part of the process because the temptation is to be broad. You will work with the
course mentor to determine an appropriate topic for your technical project. Where does your
expertise lie? If your degree program has an emphasis, what interests you about that emphasis?
What do your peers say about your idea? Have you queried them on the message board?

Defining the Topic


To a certain extent, brainstorming and lots of thinking helps with choosing a topic. The trick is to
focus your thinking as soon as you can. The activities that follow will help you do that.

This topic addresses the following competency:

4/11
TWA1 - Technical Writing
Course of Study

Competency 405.2.1: Project Proposal


The graduate prepares a project proposal according to the guidelines specified in the
program guide.

Selecting a Format

A technical project can take on one of four forms: intellectual product or service; physical product or
service; event or activity; or system improvements or enhancements:

Intellectual Product or Service: This is an analytical, critical paper that investigates an aspect
of the information technology field directly related to your program. This paper can be an
investigation of newly-introduced, cutting-edge technology or another approved topic.
Physical Product or Service: This is a design of a service or system that reflects awareness of
similar work done by others, and is relevant by design standards and regulation.
Event or Activity: This is an event or activity scheduled, planned, and carried out that
specifically relates to your program.
System Improvements or Enhancements: This is a written document or physical artifacts that
provide detail about intended outcomes of the project improvements or enhancements,
including information about the originating problem or need.

Determining a Topic

You have a great deal of flexibility in selecting a topic after you have determined the technical
project format. Here are several recent examples:

From the BSIT Program:

virtualization pilot for server consolidation


migration from Novell Groupwise 7 to microsoft Exchange 2007
choosing the right IT frameworks for your organization
reorganizing course content repository to improve reuse

From the Network Administration Emphasis:

IT and network security


server consolidation and virtualization
calWin software deployment using SMS 2003
thin-client implementation
incident management
LANDesk implementation
network implementation for XYZ Solutions, Inc.
testing network for network monitoring system verification
worldwide information technology modernization (WITM)
adding an e-commerce department to the business-depot store
soil moisture sensor network
technology disaster recovery plan

5/11
TWA1 - Technical Writing
Course of Study

From the Security Emphasis:

implementing a streamlined information assurance program


upgrading point-of-sale software to securely store credit card data
securing a wireless network
network monitoring with service-level management
generic security design for a hospital
personal information privacy protection project
single sign-on integration with corporate active directory

From the Software Emphasis:

using IBM rational automation in manual testing environments


sharePoint 2007 Server for enterprise collaboration and document management
clock synchronization tool for handheld devices

From the Database Emphasis:

building a global rock climbing database


implementing dynamic update website capabilities

Writing Idea Paper

After determining an appropriate topic for your capstone project, you will expand it into a one to two
page idea paper that fleshes the topic into more detail. Your mentor must approve the idea paper
before you begin your proposal.

Technical Project Proposal Development Phase


Now you will do the majority of the work for the Technical Writing assessment; you will compose
the proposal to be graded. The technical project proposal serves several purposes. First, it enables
you to demonstrate your competence in the technical writing domain. Second, it provides a way for
you to communicate a proposed technical project to your mentor and other IT faculty members who
might express an interest. Finally, it helps you organize your ideas for a technical project so you
can complete it in a timely and efficient manner.

The proposal explains how you plan to approach and carry out your project. Are you comfortable
with your current writing skills? Do you have one or more people in mind who can review your work,
especially with respect to its clarity? Are you comfortable with your topic? The technical project that
you are proposing will follow one of the following four formats:

1. intellectual product or service


2. physical product or service
3. event or activity
4. system improvements or enhancements

6/11
TWA1 - Technical Writing
Course of Study

How to Construct the Proposal


This is where the serious writing begins. If you want further information on the rubric or on the APA
formatting and writing style, visit the following webpage, which contains a set of slides that neatly
summarizes what you have already reviewed in more detail earlier:

" Language Aspects of Your Paper "

Take small bites and chew well. Talk to your mentor about pacing; it is well worth the extra effort to
stay on pace.

This topic addresses the following competency:

Competency 405.2.1: Project Proposal


The graduate prepares a project proposal according to the guidelines specified in the
program guide.

Writing a Summary

Provide a summary (about two to three pages) of your proposed technical project. Your idea paper
will serve as the starting point for the summary. The summary, however, includes coverage of all
sections in the proposal.

Writing a Review of Other Work

In this section (about two to three pages), you will review other work that is relevant to your
technical project. Perhaps there are case studies of similar projects, comparisons of various
solutions, or related articles. For example, if you are planning a network security project, you might
choose to summarize articles that describe the business case for improved security, comparisons
of various hardware and software products that are possible alternatives for your project, and case
studies that relate to the project you are planning.

Writing a Project Rationale

This section (about two to three pages) discusses the reasons for implementing the project
described in your proposal; rationale may consist of both business and technical reasons.

Writing a Systems Analysis and Methodology

This section (about two to three pages) describes the current state of the project environment and
discusses how the current state will drive or affect the definition and implementation of your
proposed solution. Other detailed analysis can be included here as well.

This section also defines the specific methodology (process) that you will follow when you execute
your project.

7/11
TWA1 - Technical Writing
Course of Study

Writing Goals and Objectives

List the goals and objectives (five to eight pages) of your technical project. Describe each in detail
and explain how the project will help to attain them. You should note that goals and objectives are
not necessarily technical in nature. Some of them will reflect business or organization goals. You
should also discuss how you would recognize reaching the goals and objectives.

Writing Deliverables

Explain in five to eight pages what types of deliverables your project will provide. For example, you
could explain that your project will include some sort of formal report. It will likely also include a
technical IT product and a user's manual or other documentation.

Writing Plan and Timelines

Include in your proposal a projected timeline for your technical project, with milestones. In this
section, you will demonstrate the IT project management skills that you have developed during your
degree program. Remember that these are estimates made before you even begin the technical
project. It is not uncommon for project plans to require revision once the project is underway.

Technical Writing Document Preparation and Grading


Phase
This is about packaging, and it is important. The appearance of obvious items can affect the way
that content is viewed. If you are going to buy something, do you want it to look good, or is it okay if
it looks so-so? This phase of the assessment is critical; it is where remaining sections of your
technical proposal are developed, and where all sections are assembled into the document that is
submitted for grading. In this phase, you will also do a final check of grammar, mechanics, and
APA format. After the technical proposal is submitted for grading, the results are usually returned to
you in three to five business days. You should note that if the grading finds deficiencies in your
proposal, you are responsible to modify and resubmit it for additional grading. A little extra advance
work can help minimize post-grading revisions.

Technical Writing Document Preparation and Grading


There are seven activities for this topic:

1. Prepare the technical writing cover sheet.


2. Develop the competency matrix.
3. Prepare other sections (e.g., table of contents, bibliography, appendices).
4. Compile all sections of the capstone proposal into a single document.
5. Review all sections of the capstone proposal for language, APA format, etc.
6. Submit capstone proposal to the TWA1 assessment in TaskStream for grading.
7. Revise the capstone proposal if it does not meet the requirements of the rubric.

8/11
TWA1 - Technical Writing
Course of Study

This topic addresses the following competency:

Competency 405.2.1: Project Proposal


The graduate prepares a project proposal according to the guidelines specified in the
program guide.

Preparing Cover Sheets

The cover sheet has the following information on it:

project name
your name
your degree program
your mentor's name
signature block, with a space for your mentor's signature, your signature, and the date

In the link below is a sample of what the project cover sheet should look like:

Project Coversheet Template

Preparing Other Sections

Prepare any other documents that are required to complete your proposal (e.g., table of contents,
bibliography, appendices). You will likely have developed each section of your technical project
proposal as separate documents. However, other sections may need preparation before you can
pull all of them together. Virtually all word processing software will generate a table of contents if
you have used named styles in your document.

Other sections that may need preparation include the bibliography of works cited in your proposal
and any appendices that your proposal requires.

Compiling All Sections into a Single Document

At this point, your work is perhaps a collection of individual documents. You must now compile
them into a single file. Your proposal should consist of a single word-processing document. If you
have file listings from other applications (e.g., a flowchart) then put them in an appendix and submit
a ZIP file.

Reviewing All Sections for Language, APA Format, Etc.

As you develop your proposal, you may not need too much writing assistance. Nevertheless, even
the best writers benefit from "another set of eyes" to help clarify ideas, identify mechanical issues,
and apply the APA guidelines. Ask a trusted reader to review your work and make note of any
items your reader identifies.

9/11
TWA1 - Technical Writing
Course of Study

If you need additional help with any part of the writing or revision process, contact WGU's Center
for Writing Excellence (CWE). Whatever your needs-writing anxiety, grammar, general college
writing concerns, or even ESL language-related writing issues-the CWE is available to help
you. The CWE offers personalized individual sessions and weekly group webinars. For an
appointment, please e-mail: writingcenter@[Link].

Submitting to TaskStream for Grading

Make sure that you have a backup of the final report, including all attachments. Then submit your
final report in TaskStream .

Revising the Proposal If Needed

If your proposal is deficient, you will receive it with feedback to indicate the areas requiring revision.
Otherwise, a "Pass" is entered into your Student Degree Plan.

Final Steps
Congratulations on completing the activities in this course! This course has prepared you to
complete the assessment associated with this course. If you have not already been directed to
complete the assessment, schedule and complete your assessment now.

Accessibility Policy
Western Governors University recognizes and fulfills its obligations under the Americans with
Disabilities Act of 1990 (ADA), the Rehabilitation Act of 1973 and similar state laws. Western
Governors University is committed to provide reasonable accommodation(s) to qualified disabled
learners in University programs and activities as is required by applicable law(s). The Office of
Student Accessibility Services serves as the principal point of contact for students seeking
accommodations and can be contacted at ADASupport@[Link]. Further information on WGU's
Accessibility policy and process can be viewed in the student handbook at the following link:

Accessibility Policy

Student Support
WGU values your input! Please submit any feedback you have using the following form:

10/11
TWA1 - Technical Writing
Course of Study

Course Feedback

Access the WGU Library 24 hours a day, 7 days a week:

WGU Library

Visit the Student Success Center to access a variety of topics that will help you succeed at WGU:

Student Success Center

Contact the WGU Writing Center for help with any part of the writing or revision process:

WGU Writing Center

11/11

You might also like