#contents
** Week1 Student Lounge [#b57ddd4c]
- Question
WRTG 393 students,
Welcome to the class! Please introduce yourself to the rest of the class. You might state your major (if you have one), why you are taking WRTG 393, and any other interesting details you would like to share.
Thanks
- Answer
Hello everyone,
My name is Yuji Shimojo and I'm 28. I am from Okinawa, Japan and just moved to Tokyo three months ago. I used to study Information Engineering at University of the Ryukyus in Okinawa, but I dropped out of the college 6 years ago. While in the college, I had lived in San Jose, California for 6 months for an internship. I'm currently majoring in Computer Science with a minor in Business Administration.
Yuji
** Week1 Definitions of and experience with technical writing [#g6daf053]
- Question
WRTG 393 students,
In this discussion topic, we will discuss what technical writing is. Please answer the following questions. Feel free to interact with your classmates on their answers as well.
1. From your own experience, please provide a definition of technical writing. You may use the information in Unit 1 of your textbook to help you in constructing your definition if you would like to.
2. Read over pages 129-131 of the article by Kitty Locker, “Will Professional Communication Be the Death of Business Communication?” The article is in the ''eReserves'' section of your class. To access the article, please take the following steps:
-- click ''Content''
-- select ''Class Resources''
-- select ''eReserves''
-- select ''the icon for eReserves'' in the middle of your page.
-- in the list of items that appears, locate this article and download it.
How does Locker distinguish technical writing from business writing? Write a couple of sentences or so in your response to this question.
How does Locker distinguish technical writing from business writing? Write a couple of sentences or so in your response to this question.
3. Read over pages 325-3236 of the article by Mark Gellis, “Autobiographical Writing in the Technical Writing Course.” The article is also in the ''eReserves'' section of your class.
How does Gellis distinguish an essay from a report or a proposal? Write a couple of sentences or so in your response to this question.
4. In your life, have you written any documents that might be labeled technical writing? If so, what did you write?
5. In your life, have you had to read or work through a piece of technical writing that you found problematic? If so, what was the document, and why was it problematic to work with?
- Answer
1. From your own experience, please provide a definition of technical writing. You may use the information in Unit 1 of your textbook to help you in constructing your definition if you would like to.
Because I work in the IT field, technical writing I come up with is to write software documents such as software requirements specifications (SRSs), software design documents (SDDs), software test specifications (STSs), and software development plans (SDPs). In my opinion, when you write such documents, it is very important that you define who readers at first. Even if you write instructions and procedures on how to do something in detail, if your document have an entirely different expectation for your readers, it makes no sense.
2. How does Locker distinguish technical writing from business writing? Write a couple of sentences or so in your response to this question.
According to Locker, K. O. (2003), business communication has only its own concerns, insight, and identity. It focuses on persuasion and context. In contrast, Technical communication focuses on exposition and explanation.
3. How does Gellis distinguish an essay from a report or a proposal? Write a couple of sentences or so in your response to this question.
According to Gellis, M. (2011), essays are subjective, and are written not only to explain, but express, entertain and reveal the author's personal interaction with the subject. They will do more than simply give you a set of observed facts and objective conclusions.
On the other hand, reports are objective, analytical, and purely referential. They are written from one professional to another, and have the aim of achieving a profession-related goal.
To me the most interesting Gellis's description for comparison between reports and essays are that reports are written for people who need the information, whether or not they want it; in contrast, essays are written for people who want the information, whether or no they need it.
4. In your life, have you written any documents that might be labeled technical writing? If so, what did you write?
I usually write up SDDs, STSs, and SDPs according to SRSs from customers. A SDD includes E-R diagrams (ERDs), architectural context diagrams (ACDs), sequence diagrams (SDs), and data flow diagrams (DFDs), etc.. A STS includes test cases of black box and white box testing and the results. A SDP includes organizational charts which describe the project team and external entities or stakeholders with roles and responsibilities, work breakdown structures (WBSs), and risk management plans, etc..
5. In your life, have you had to read or work through a piece of technical writing that you found problematic? If so, what was the document, and why was it problematic to work with?
Sometimes I face problem with a SRS which our customer wrote. The problem is that the SRS doesn't say anything about the objective or the project goal. Since software engineering is a tool to solve some kind of problems, we can find what the problem really is, and provide a solution to solve it to achieve the goal; however, if the goal is unclear, we can hardly provide it.
CENTER:References
-- Gellis, M. (2011). Autobiographical Writing in the Technical Writing. '''Baywood Publishing Co., Inc.,''' 325-326, doi:10.2190/TW.41.3.g
-- Locker, K. O. (2003). Will Professional Communication Be the Death of Business Communication?. '''Business Communication Quarterly, 66(3),''' 129-131.
** Week1 analyzing two technical descriptions [#dda4eca3]
- Question
WRTG 393 students,
This task is designed to help prepare you for the first writing assignment, the technical description
At the top of the Content area for Week 1, you will see two items:
-- [[how hybrid cars work:https://www.fueleconomy.gov/feg/hybridtech.shtml]]
-- [[how laser printers work:http://www.explainthatstuff.com/laserprinters.html]]
Please peruse those two webites. The hybrid car website has a Flash as well as an html version you can explore.
Then examine the following two reading texts. The first one is available through eReserves
''“Writing Descriptions” by Mike Markel''
You can access the document by taking the following steps:
-- click ''Content''
-- select ''Class Resources''
-- select ''eReserves''
-- select ''the icon for eReserves'' in the middle of your page.
-- in the list of items that appears, select the Markel chapter
''[[Technical Description: What Does it Look Like?:https://www.prismnet.com/~hcexres/textbook/desc.html]]'' ''By David McMurrey''
Please respond to this discussion topic by answering the following question:
''&color(blue){'How do the two technical descriptions—the one on hybrid cars and the one on laser printers—apply the strategies given by either Markel or McMurrey?};''
Please select at least one of the technical descriptions and at least one of the two authors, Markel or McMurrey, and write one paragraph analyzing how the technical descriptions do or do not apply the strategies the author(s) mentions. You can write 100-150 words.
- Answer
Both the two technical descriptions give an introduction or an overview, discuss the parts or characteristics, and use graphics and headings, which McMurrey. mentions in Contents and Organization of Descriptions and Graphics and Format in Descriptions. Also, both clearly show Markel's objects, mechanisms, and processes.
The difference between the two technical descriptions is that the description of laser printers give its background as introducing the first laser printer invented by Gary Starkweather and explaining how it works, although the description of hybrid cars don't do so.
On the other hand, the hybrid cars' description gives more detailed illustrations. In addition to clearer the shape and the dimensions, it provides graphics showing different views and step-by-step illustrated instructions, which Markel mentions in Providing Appropriate Detail.
** Week2 strategies in writing instructions -- advice from some websites [#h52e487f]
- Question
WRTG 393 students,
One of our writing assignment (WA #2) involves writing an instruction manual. This discussion topic is designed to help you prepare for that assignment.
Please peruse the following web pages. They are linked to above, at the top of this week's content.
-- ''David McMurrey -- Instructions: Tell Them How to Do It!''
-- ''Writing Commons: Instructions and Process Reports''
-- ''Wikibooks: Professional and Technical Writing/Instructions''
-- ''Jerz's Weblog -- Instructions: How to Write Guides for Busy, Grouchy People''
1. Imagine you are helping write an instruction manual for UMUC students on how to access their classes in LEO. How might you revise the following sentences if they were proposed for an instruction manual?
''&color(blue){The user should log into the LEO system};''
''&color(blue){The class will be on the right-hand side. You have to click on the class to access it.};''
''&color(blue){The class will appear in your interface. You will need to select whatever menu item you want to access in order to access it.};''
2. Please comment on any piece of advice given in these websites. Write a sentence or two describing the advice and what the chapter noted about it. Try to comment on a section of the chapter that one of your classmates has not commented on yet.
- Answer
** Week2 an "instruction manual" for the Kindle Fire [#r8e63060]
- Question
WRTG 393 students,
The following discussion topic is designed to help you prepare for writing assignment #2, the instruction manual. Directions for that writing assignment can be accessed by clicking [[here:http://info.umuc.edu/academicwrtg/WAs/393/393_IM.html]].
To complete this discussion topic, please do the following:
Watch the following video, which is sort of an instruction manual on the Kindle Fire:
https://www.youtube.com/watch?v=pEOLIF5qKZA&feature=youtu.be
Then answer the following questions or complete the following tasks.
1. The author of this manual does not define any terms. What terms might need to be defined to a user who is not at all familiar with the Kindle and who may never have purchased a electronic book? Please note that I am not asking you to define any terms. However, I am asking you to identify what terms might need to be defined.
2. The author begins immediately with the instructions. He does not start off with an introduction to the device or an explanation of why one would want to know how to use the device.
Please write a one-paragraph introduction that might be suitable for the Kindle Fire.
- Answer
** Week2 technical description for two audiences [#ed132a5a]
- Question
// #ref(WRTG393_WA1_393_technicaldescription.pdf,,90%)
https://umuc.equella.ecollege.com/file/f2b3c265-cb66-415e-bc36-deb9946be717/3/WA1_393_technicaldescription.pdf
- Answer
![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
