eng300 table contents new3

Upload: jasminesharita

Post on 06-Apr-2018

252 views

Category:

Documents


0 download

TRANSCRIPT

  • 8/3/2019 Eng300 Table Contents New3

    1/27

    Professional Report

    for

    Dr. Reynolds

    Prepared for

    Dr. Reynolds

    William Paterson UniversityWayne, New Jersey

    By

    Jasmine Burroughs

    William Paterson University

    March 31, 2011

    This report provides readers with in-depth information on the field of TechnicalCommunications. It allows reader to create documents that can be used in all aspects of their

    lives. It can be used in many careers besides Technical Communications.

  • 8/3/2019 Eng300 Table Contents New3

    2/27

    MEMORANDUM

    To: Dr. ReynoldsFrom: Jasmine Burroughs

    Date: March 31, 2011

    Subject: Transmittal Memo

    Attached to this report please find a portfolio that outlines what is involved in Technical

    communications.

    The attached report includes

    Website accessibility

    Characteristics of quality technical communications

    Content analysis

    Document style redesign

    Visuals

    Process instructions and task analysis

  • 8/3/2019 Eng300 Table Contents New3

    3/27

    Table of Contents

    EXECUTIVE SUMMARY..............................................................................................................i

    Introduction..............ii1.0 WEBSITE ACCESSIBILITY....................................................................................................1

    1.1 Website Analysis........................................................................................................................1

    2.0CHARACTERISTICS OF QUALITY TECHNICAL COMMUNICATION...........................2

    2.1Technical Terms and Concepts...................................................................................................2

    2.2 Writing Assessment...................................................................................................................3

    3.0 AUDIENCE/CONTEXT/PURPOSE ANALYSIS....................................................................4

    3.1 Audience Usability Checklist.....................................................................................4

    3.2 Analyzing Audience...................................................................................................................5

    4.0 DOCUMENT STYLE REDESIGN ..........................................................................................6

    4.1 Style Sheet.................................................................................................................................64.2 Document Style Redesign......................................................................................................7

    5.0 REFERENCED VISUALS......................................................................................................115.1 Reformatted Article with Visuals ...........................................................................................11

    5.2 Visual Analysis........................................................................................................................16

    6.0 PROCESS INSTRUCTIONS/TASK ANALYSIS .................................................................176.1 Materials List...........................................................................................................................17

    6.2 Instructions..............................................................................................................................18

    6.3 Analysis...................................................................................................................................197.0 Conclusion.......20

    8.0 Recommendation.........21

  • 8/3/2019 Eng300 Table Contents New3

    4/27

    i

    EXECUTIVE SUMMARY

    The assignment included allows readers to get an understanding of how to reformat articles. Thearticles can be re formatted so that readers can better understand. The assignments included are

    memos to backup information provided in assignments. There are also reformatted articles. One

    of the reformatted articles includes visuals for readers to relate to. There is also a materials listand instructions that allow users to create an object. Included in the report is also ways to

    improve the instruction list for the Tinker Toys project.

    Students can use these assignments in their everyday lives as well as in future careers.

    Depending on the career, students may be required to give presentations or put information in

    more simple terms. These assignments are like a guideline for readers to follow. The assignmentsgive a step by step approach to the technical communications process.

  • 8/3/2019 Eng300 Table Contents New3

    5/27

    ii

    INTRODUCTION

    Many English writing students are taught to write a certain way. This course allows students to

    branch away from creative writing. Technical writing has nothing to do with the way individuals

    feel. Therefore, there is no first person in technical writing. The information that is given should

    be in third person. Many students are not use to writing in technical terms. This course givesstudents the opportunity to create technical documents that have to be formatted properly to meet

    the users needs.

  • 8/3/2019 Eng300 Table Contents New3

    6/27

    Technical Writing Portfolio 1

    1.0 WEBSITE ACCESSIBILITY

    1.1 Website analysis

    Audience: Rhoda Reynolds

    MEMORANDUM

    TO: Rhoda Reynolds

    FROM: Jasmine Burroughs

    DATE: March 31, 2011

    SUBJECT: Website Accessibility

    STC

    The Society of Technical Communicator (STC) gives members access to jobs that are available

    in Technical Communications. It allows professionals to network with others in the field. There

    is also detailed information provided to individuals that want to further their education. There are

    links to colleges that offer degrees in technical communications.

    IABC

    The International Association of Business Communicators (IABC) allows members to networkwith other professionals in the field. They provide information on distance learning, and

    conferences near them. Their monthly publication allows members to stay up to date in the field

    of communications. Members can join a local chapter and are encouraged to start their own.

  • 8/3/2019 Eng300 Table Contents New3

    7/27

    Technical Writing Portfolio 2

    2.0 CHARACTERISTICS OF QUALITY TECHNICALCOMMUNICATION

    2.1 Technical terms and concepts

    Assessment (n) the evaluation or estimation of the nature, quality, or ability of someone orsomething. Manuscript (n) an author's text that has not yet been published.

    Peer-Review (n) evaluation of scientific, academic, or professional work by others working inthe same field.

    Citation (n) a quotation from or reference to a book, paper, or author, especially in a scholarly

    work.

    Genre (n) a category of artistic composition, as in music or literature, characterized by

    similarities in form , style, or subject matter.

    Proofread - (v) read (printer's proofs or other written or printed material) and mark any errors.

    MLA - (abbreviation) Modern Language Association (of America)

    Paraphrase - (v) express the meaning of (the writer or speaker or something written or spoken)

    using different words, especially to achieve greater clarity

    Linguistics - (plural noun) the scientific study of language and its structure, including the study

    of morphology, syntax, phonetics, and semantics.

    Publishing (n) the occupation, business, or activity of preparing and issuing books, journals,

    and other material for sale

  • 8/3/2019 Eng300 Table Contents New3

    8/27

    Technical Writing Portfolio 3

    2.2 Writing assessment

    Audience: Dr. Rhoda Reynolds

    Memorandum

    TO: Rhoda Reynolds

    FROM: Jasmine Burroughs

    DATE: March 31, 2011

    SUBJECT: Writing Assessment Memo

    I plan on publishing a Holistic Health magazine that focuses on the urban community. Most of

    the information will involve medical writing and a lot of research on the subject. The information

    gathered for the articles will come from current knowledge, interviewing health professionals,and Holistic Health Expos. The information will be put in a simple format so readers can easily

    relate to holistic health.

    Many of the writing will address issues among African American women and women in urban

    communities. The writing will be made clear and concise for readers to be able to navigatethrough the articles. The magazine will be and online magazine. Depending on the success of the

    online magazine, readers may eventually be able to subscribe to print magazines.

  • 8/3/2019 Eng300 Table Contents New3

    9/27

    Technical Writing Portfolio 4

    3.0 AUDIENCE/CONTEXT/PURPOSE ANALYSIS

    3.1 Audience usability checklist

    Have I identified my exact audience (primary and secondary)?

    Have I identified my relationship with this audience?

    Have I identified this audiences technical background?

    Have I identified this audiences cultural background?

    Have I identified the exact purpose of this document (primary and secondary)?

    Have I written a purpose statement?

    Do I know exactly how this information will be used?

    Have I identified the steps involved, by creating a task analysis?

    Have I pinpointed the main tasks and the subtasks?

    Have I considered the documents setting, potential problems, lengths, format, timing, andbudget?

    Have I developed an information plan that outlines all the above factors?

    After drafting the document, have I tested it wit potential users or readers?

    Have I identified any problems in terms of content, organization, style, layout and visuals, andethical/legal/cultural considerations?

    Did I make needed revisions based on testing?

  • 8/3/2019 Eng300 Table Contents New3

    10/27

    Technical Writing Portfolio 5

    3.2 Analyzing audience

    Audience: Rhoda Reynolds

    MEMORANDUM

    TO: Rhoda Reynolds

    FROM: Jasmine Burroughs

    DATE: March 31,2011

    SUBJECT: Analyzing Articles Audience Memo

    The article will be clear and concise for readers to navigate through. Readers will be given

    information on two subjects. One subject readers will be reading about is Ethics. The Ethics

    section allows readers to be more conscious about issues that revolve around providing citationson documentation. There are examples provided on situations with the conflict of interest. This

    section gives readers an understanding of issues that may also arise in the work place. There areexamples provided in the article as well as graphics to correlate with the article. Anyone who are

    curious about these subjects may be interested in reading this article. Many business professionalmay find this article interesting as well.

  • 8/3/2019 Eng300 Table Contents New3

    11/27

    Technical Writing Portfolio 6

    4.0 DOCUMENT STYLE REDESIGN

    4.1 Style sheet

    Style Sheet: Group 4

    Heading:

    1. ARIAL 14 POINT BOLD, ALL CAPS

    Body:

    2. Copy will be Times New Roman 12 Point

    3. All margins at 1-inch.4. Paragraphs will begin flush left.5. Double space between paragraphs.

    6. Bullets will all be the same style: square bullet. If the writer has used -, *, + or

    anything else, replace with bullet.7. Use the following forms: nineteenth century (NOT 19th century - and note that

    the words should be hyphenated if they modify a noun, e.g., nineteenth-century

    astronauts); 16 August 1967 (not August 16, 1967 or 16 Aug. 1967). Do not usecommas in dates. For decades use 1960s, 1970s.Do notuse sixties, 70s,

    1980s.

    8. Avoid the use of contractions such as wont, didnt, cant.

    9. Spell out words such as table, figure, percent, and November, in text.Abbreviations are acceptable in footnotes, tables etc., as long as this is consistent

    throughout the entire volume.

    10. Websters Dictionary is our arbiter for American-English. We use the z spellingfor all words ending in ize, ization, (socialize, organization). Consistency in

    spelling is most important; however, alternative spellings in quoted material and

    book and article titles should not be changed.

    11. When you type the word Figure followed by a number, make them bold. For

    example: Figure 1.

  • 8/3/2019 Eng300 Table Contents New3

    12/27

    Technical Writing Portfolio 7

    4.2 Document style redesign

    ETHICS

    When preparing a manuscript for publication several ethical issues should be considered. Theseinclude duplicate publication, inaccuracy of citations, fraudulent publication, and plagiarism.

    Some journals have developed policies about duplicate submission and publication. The

    Ingelfinger Rule, initiated by Franz Ingelfinger in 1969 while he was the editor of theNew

    England Journal of Medicine, allows for consideration of a manuscript onlyif its substance hasnot been submitted or reported elsewhere(Angell & Kassirer, 1991). Editors must have exclusive

    rights to manuscripts (Copp, 1993). An author submitting a manuscript should inform the editor

    of overlapping or duplicate materials submitted or published because many editors have concerns

    about submitting various aspects of one project or study to several different journals. Duplicatepublication can result in unnecessary articles, detract from the interpretation of a single

    manuscript, and fragment retrieval (Angell & Relman, 1989; Bishop, 1984; Blancett, Flanagin,& Young, 1995). The question of how many articles should be generated from a singleproject

    and whether a poster is considered a published work remain unanswered. In regard to the second

    question, the editors of theNew England Journal of Medicine have taken the position that postersare equivalent to abstracts, thus, they can be displayed without jeopardizing manuscript

    publication. Additional criteria for determining when material is duplicate are in Table 1 as are

    several recommendations.

    Reasons for duplicate publication include self-promotion and the need for power (Blancett,

    1991a; Blancett, 1991b). The number of authors who deliberately publish duplicate papers isunclear. Boots and colleagues (1992) described a 12% duplicate publishing rate over 4 years,

    which may be an underestimate. A more recent study by Blancett, Flanagin, and Young

    (1995)revealed a 28% duplicate publishing rate. Occasionally editors agree to duplicatepublication when a second article accurately reflects the primary article and there is a footnote in

    the second paper informing readers about the primary article (Blancett,1991).

    With respect to the accuracy of citations Biebuyck (1992) noted two types of errors: (a)

    carelessness and excessive haste or (b) deliberately misleading or missing information. The

    purpose of citations is to credit original work, show relationships to the authors methods andfindings, and enable readers to locate sources (Biebuyck). Errors can indicate a lack of discipline

    and carelessness. Sometimes bibliographic inaccuracies can be traced to previous publication

    errors.

  • 8/3/2019 Eng300 Table Contents New3

    13/27

    Technical Writing Portfolio 8

    In scholarly papers, authors should check and cite primary rather than secondary sources.

    Original material must be correctly quoted in context and citations must be accurate. Studies ofcitations demonstrate an error rate ranging from 34% to 56%. Erroneous or missing informationfrom citations may include title, volume number, page numbers, issue number, and journal name

    (McLellan, Chase, & Barnett, 1988). Kirchhoff (1995) describes preventing reference errors by

    careful proofreading of manuscripts and page proofs.

    Fraudulent publication encompasses plagiarism, fabrication, and falsification. Reasons for fraudor misconduct include concern about course grades, status, and power. Other reasons include

    competition, pressure to get ahead, and inadequate supervision (Chop & Silva, 1991; Clark,

    1993). Hawley and Jeffers (1992) suggested that scientists who publish regularly average about

    one publication a year and noted that having many, many publications above this average isfound in publicized cases of misconduct although few instances have been reported of nurses

    being involved in fraudulent publication, nurses should be aware this potential exists.

    Plagiarism is the theft of intellectual property (Berg, 1990; Berk, 1991; Rogers, 1993) either

    in written or oral form. Responsibility for avoiding plagiarism rests with the writer. But scholars,editors, and reviewers also are responsible.

    Self-plagiarism is probably also unethical. Some authors have written chapters for severaldifferent books that are changed only slightly, but because each work is generally copyrighted

    when published, the author no longer owns the work and should not plagiarize. Generally

    speaking, authors should not copy their own material unless the original publishing contractgives them permission. Alternatively, authors may quote short phrases of their own work,

    reference these appropriately, and consult the editor of the original journal or book (Blancett,1993). Rogers (1993) provides numerous helpful recommendations to avoid plagiarism fornurses who are novices at writing and publishing.

    Nurses can address problems of fraudulent publication or ethical problems in publication bytaking steps to decrease its frequency and depth. Nurses should ask: What are the areas of

    fraud? How can fraud be detected? How informed are nurses about misconduct?(See Figure 1

    for visual).

  • 8/3/2019 Eng300 Table Contents New3

    14/27

    Technical Writing Portfolio 9

    CONFLICT OF INTEREST

    A broad definition of conflict of interest is a situation in which personal interests could

    compromise, or could have the appearance of compromising, the ability of an individual to

    carryout professional duties objectively (Biaggioni, 1993, p. 322).Editors periodically reviewpolicies and procedures to ensure that appropriate disclosure is required of potential presenters

    and authors.

    Guidelines have been prepared to assist investigators and representatives from universities and

    other institutions to deal with actual or potential conflicts of interest. Two such organizations,The Association of American Medical Colleges and The American Federation for Clinical

    Research, have issued guidelines dealing with public disclosure of all relevant information. The

    American Medical Association and the Pharmaceutical Manufacturers Association also have

    guidelines regarding ethical support from pharmaceutical companies.

    Intellectual conflict of interest is often elusive and difficult to define. When authors submit amanuscript, they are asked to follow journal guidelines and to indicate if they have published the

    same or a substantially similar manuscript elsewhere (Blancett, 1993). A broad definition of

    intellectual conflict of interest includes situations in which knowledge may contradict what isreported. For example, most authors cite references supporting their work, but some may either

    incorrectly cite the references or cite references that do not adequately support their contentions.

    Appropriate acknowledgment in a manuscript in which authors use the instruments of others is

    also a requirement.

    In recent years, reviewers have been asked to note whether they perceive conflicts ofinterestwhen they agree to participate in journal activities such as serving on editorial boards or

    reviewing manuscripts. Potential problems with these requests are that reviewers may react

    unfavorably when they are asked to submit to the same kind of disclosure asauthors, particularlywhen they work anonymously and without remuneration (Rennie, Flanagin, & Glass, 1991).

    The issue of financial conflict of interest arose from concerns about the uses and potential abusesof scientific research. Financial conflict of interest is a situation where there is financial

    association between the authors and a commercial venture. The potential gain an investigator

    may receive, for example, ownership of stocks and receipt of funds for testing drugs or otherproducts, are of concern. While support is usually acknowledged by investigators, some readers

    may still question the integrity of results. Authors who receive such support should refrain fromactions that could be construed as promoting a product.

  • 8/3/2019 Eng300 Table Contents New3

    15/27

    Technical Writing Portfolio 10

    Financial disclosure is required of authors when submitting manuscripts to most professional

    journals. Guidelines related to financial conflict of interest include acknowledging all researchsupport (intramural and extramural); stating any financial relationship between authors andcommercial products involved in the research; listing any affiliations with a direct interest in the

    subject matter (e.g..employment, consultancies, stockownership, honoraria, expert testimony);

    adhering to the authors understanding form; and insisting that members of the editorial boardand reviewers also disclose any financial conflict of interest in a company or product in

    competition with that discussed in a manuscript they are reviewing. There are no easy answers to

    conflict of interest, but conflicts should be discussed to safeguard scientific integrity. (See Figure

    2 for visual).

    Table 1: DUPLICATE PUBLICATIONS

    Characteristics1. Identical content.

    2. Highly similar articles with minimal modifications.

    3. Several articles when one would usually suffice.4. Sequential articles about the development of a project.

    5. Similar articles for various disciplines.

    Recommendations For Authors

    1. Obtain author guidelines from a journal.2. Read the journals policies carefully.

    3. Talk to the editor before submitting a manuscript if there is concernabout possible duplication.Recommendations For Editors

    1. Announce the journals policy concerning duplicate publishing.

    2. Ask authors to submit copies of previously published or related3. Remind authors of the journals policies concerning duplication.

    4. Attend meetings to share the journals policies with potential

    5. Use peer review.

    materials.authors.

    Note. Based on information from Blanwtt, 1991a; Blancett et al., 1995, Smith.

    Miller, Saidman, & Morgan, 1991; Yarbro, 1995.

  • 8/3/2019 Eng300 Table Contents New3

    16/27

    Technical Writing Portfolio 11

    5.0 REFERENCED VISUALS

    5.1 Reformatted article with visuals

    ETHICS

    When preparing a manuscript for publication several ethical issues should be considered. These

    include duplicate publication, inaccuracy of citations, fraudulent publication, and plagiarism.Some journals have developed policies about duplicate submission and publication. The

    Ingelfinger Rule, initiated by Franz Ingelfinger in 1969 while he was the editor of theNewEngland Journal of Medicine, allows for consideration of a manuscript onlyif its substance hasnot been submitted or reported elsewhere(Angell & Kassirer, 1991). Editors must have exclusive

    rights to manuscripts (Copp, 1993). An author submitting a manuscript should inform the editorof overlapping or duplicate materials submitted or published because many editors have concerns

    about submitting various aspects of one project or study to several different journals. Duplicatepublication can result in unnecessary articles, detract from the interpretation of a single

    manuscript, and fragment retrieval (Angell & Relman, 1989; Bishop, 1984; Blancett, Flanagin,

    & Young, 1995). The question of how many articles should be generated from a singleprojectand whether a poster is considered a published work remain unanswered. In regard to the second

    question, the editors of theNew England Journal of Medicine have taken the position that posters

    are equivalent to abstracts, thus, they can be displayed without jeopardizing manuscriptpublication. Additional criteria for determining when material is duplicate are in Table 1 as are

    several recommendations.

    Reasons for duplicate publication include self-promotion and the need for power (Blancett,

    1991a; Blancett, 1991b). The number of authors who deliberately publish duplicate papers is

    unclear. Boots and colleagues (1992) described a 12% duplicate publishing rate over 4 years,which may be an underestimate. A more recent study by Blancett, Flanagin, and Young

    (1995)revealed a 28% duplicate publishing rate. Occasionally editors agree to duplicate

    publication when a second article accurately reflects the primary article and there is a footnote inthe second paper informing readers about the primary article (Blancett,1991).

    With respect to the accuracy of citations Biebuyck (1992) noted two types of errors: (a)carelessness and excessive haste or (b) deliberately misleading or missing information. The

    purpose of citations is to credit original work, show relationships to the authors methods and

    findings, and enable readers to locate sources (Biebuyck). Errors can indicate a lack of disciplineand carelessness.

  • 8/3/2019 Eng300 Table Contents New3

    17/27

    Technical Writing Portfolio 12

    Sometimes bibliographic inaccuracies can be traced to previous publication errors.

    In scholarly papers, authors should check and cite primary rather than secondary sources.

    Original material must be correctly quoted in context and citations must be accurate. Studies of

    citations demonstrate an error rate ranging from 34% to 56%. Erroneous or missing informationfrom citations may include title, volume number, page numbers, issue number, and journal name

    (McLellan, Chase, & Barnett, 1988). Kirchhoff (1995) describes preventing reference errors by

    careful proofreading of manuscripts and page proofs.

    This visuals shows an employer and employee interacting

    Fraudulent publication encompasses plagiarism, fabrication, and falsification. Reasons for fraudor misconduct include concern about course grades, status, and power. Other reasons include

    competition, pressure to get ahead, and inadequate supervision (Chop & Silva, 1991; Clark,

    1993). Hawley and Jeffers (1992) suggested that scientists who publish regularly average aboutone publication a year and noted that having many, many publications above this average is

    found in publicized cases of misconduct although few instances have been reported of nurses

    being involved in fraudulent publication, nurses should be aware this potential exists.

    Plagiarism is the theft of intellectual property (Berg, 1990; Berk, 1991; Rogers, 1993) either

    in written or oral form. Responsibility for avoiding plagiarism rests with the writer. But scholars,editors, and reviewers also are responsible.

    Self-plagiarism is probably also unethical. Some authors have written chapters for several

    different books that are changed only slightly, but because each work is generally copyrighted

    when published, the author no longer owns the work and should not plagiarize. Generally

  • 8/3/2019 Eng300 Table Contents New3

    18/27

    Writing Portfolio 13

    speaking, authors should not copy their own material unless the original publishing contract

    gives them permission. Alternatively, authors may quote short phrases of their own work,

    reference these appropriately, and consult the editor of the original journal or book (Blancett,1993). Rogers (1993) provides numerous helpful recommendations to avoid plagiarism for

    nurses who are novices at writing and publishing.

    Nurses can address problems of fraudulent publication or ethical problems in publication by

    taking steps to decrease its frequency and depth. Nurses should ask: What are the areas of

    fraud? How can fraud be detected? How informed are nurses about misconduct?

    CONFLICT OF INTEREST

    A broad definition of conflict of interest is a situation in which personal interests could

    compromise, or could have the appearance of compromising, the ability of an individual tocarryout professional duties objectively (Biaggioni, 1993, p. 322).Editors periodically review

    policies and procedures to ensure that appropriate disclosure is required of potential presenters

    and authors.

    Guidelines have been prepared to assist investigators and representatives from universities andother institutions to deal with actual or potential conflicts of interest. Two such organizations,

    The Association of American Medical Colleges and The American Federation for ClinicalResearch, have issued guidelines dealing with public disclosure of all relevant information. The

    American Medical Association and the Pharmaceutical Manufacturers Association also haveguidelines regarding ethical support from pharmaceutical companies.

    Intellectual conflict of interest is often elusive and difficult to define. When authors submit a

    manuscript, they are asked to follow journal guidelines and to indicate if they have published the

    same or a substantially similar manuscript elsewhere (Blancett, 1993). A broad definition ofintellectual conflict of interest includes situations in which knowledge may contradict what is

    reported. For example, most authors cite references supporting their work, but some may either

    incorrectly cite the references or cite references that do not adequately support their contentions.

    Appropriate acknowledgment in a manuscript in which authors use the instruments of others isalso a requirement.

  • 8/3/2019 Eng300 Table Contents New3

    19/27

    Technical Writing Portfolio 14

    In recent years, reviewers have been asked to note whether they perceive conflicts ofinterest

    when they agree to participate in journal activities such as serving on editorial boards or

    reviewing manuscripts. Potential problems with these requests are that reviewers may react

    unfavorably when they are asked to submit to the same kind of disclosure asauthors, particularlywhen they work anonymously and without remuneration (Rennie, Flanagin, & Glass, 1991).

    The issue of financial conflict of interest arose from concerns about the uses and potential abuses

    of scientific research. Financial conflict of interest is a situation where there is financial

    association between the authors and a commercial venture. The potential gain an investigator

    may receive, for example, ownership of stocks and receipt of funds for testing drugs or otherproducts, are of concern. While support is usually acknowledged by investigators, some readers

    may still question the integrity of results. Authors who receive such support should refrain from

    actions that could be construed as promoting a product.

    Financial disclosure is required of authors when submitting manuscripts to most professionaljournals. Guidelines related to financial conflict of interest include acknowledging all research

    support (intramural and extramural); stating any financial relationship between authors and

    commercial products involved in the research; listing any affiliations with a direct interest in thesubject matter (e.g..employment, consultancies, stockownership, honoraria, expert testimony);

    adhering to the authors understanding form; and insisting that members of the editorial board

    and reviewers also disclose any financial conflict of interest in a company or product incompetition with that discussed in a manuscript they are reviewing. There are no easy answers toconflict of interest, but conflicts should be discussed to safeguard scientific integrity.

  • 8/3/2019 Eng300 Table Contents New3

    20/27

    Technical Writing Portfolio 15

    Table 1: DUPLICATE PUBLICATIONS

    Characteristics

    1. Identical content.

    2. Highly similar articles with minimal modifications.

    3. Several articles when one would usually suffice.

    4. Sequential articles about the development of a project.

    5. Similar articles for various disciplines.

    Recommendations For Authors

    1. Obtain author guidelines from a journal.

    2. Read the journals policies carefully.

    3. Talk to the editor before submitting a manuscript if there is concern

    about possible duplication.

    Recommendations For Editors

    1. Announce the journals policy concerning duplicate publishing.

    2. Ask authors to submit copies of previously published or related

    3. Remind authors of the journals policies concerning duplication.

    4. Attend meetings to share the journals policies with potential

    5. Use peer review.

    materials.

    authors.

    Note. Based on information from Blanwtt, 1991a; Blancett et al., 1995, Smith.

    Miller, Saidman, & Morgan, 1991; Yarbro, 1995.

  • 8/3/2019 Eng300 Table Contents New3

    21/27

    Technical Writing Portfolio 16

    5.2 Visual analysis

    Audience: Rhoda Reynolds

    Memorandum

    TO: Rhoda Reynolds

    FROM: Jasmine Burroughs

    DATE: March 31, 2011

    SUBJECT: Visual Analysis Memo

    Visuals are needed in a document because it expresses what words cant. People may be reading

    an article but want to relate to a picture as well. For example, the articles we read in magazines

    have visuals to allow their readers to connect with the people in the picture. If the visual is aperson, than we might be able to relate to the person in the picture. Visuals that contain cartoons

    can provide humor when appropriate to a serious subject. Having visuals just make it easier for

    people to navigate through the article. There are many times we might not be interested incontinuing to read an article, but we look to visuals as a guide to continuing.

  • 8/3/2019 Eng300 Table Contents New3

    22/27

    Technical Writing Portfolio 17

    6.0 PROCESS INSTRUCTIONS/TASK ANALYSIS

    6.1 Materials list

    Lego Inventory (24 bricks altogether)

    RED

    16 prongs = 1

    8 prong = 2

    4 prong = 6

    12 prong = 1

    2 prong = 2GREEN

    4 prong = 5

    8 prong = 1

    6 single row prong = 1

    4 single row prong = 1BROWN

    8 prong = 2

    4 prong = 2

  • 8/3/2019 Eng300 Table Contents New3

    23/27

    Technical Writing Portfolio 18

    6.2 Instructions

    Instructions

    1) The base will consist of four brown bricks. Place an 8-pronged brick next to a 4-prongedbrick. Directly above that, place a 4-pronged brick next to an 8-pronged brick (with the 8-

    pronged brick connecting the bottom two bricks).

    2) Tower three, green, 4-pronged bricks in the middle of the brown bricks.

    3) Place a green 8-pronged brick directly above the tower so that all of the bricks are in line.4)Add a green 4-pronged brick in line with the tower.

    5)Add a green 8-pronged brick in line with the tower. (Four prongs will stick out to the left)

    6) Add a green 4-pronged brick directly above so that it is in line with the rest of the tower.7) Place a red 8-pronged brick above the green 4-pronged brick so that it lies in the middle.

    8) Place a red 8-pronged brick next to a red 4-pronged brick.

    9) Directly above that, place a red 16-pronged brick.10) Add a red 12-pronged brick in the middle of the red 16-pronged brick.

    11) Place three, red 4-pronged bricks side-by-side on top of the red 12-pronged brick.

    12) In the middle of the row of three, red, 4-pronged bricks place two red 4-pronged bricks.

    13) In the middle of the row of two, red, 4-pronged bricks place one red 4-pronged brick.Caution:

    1. Children 3 years and younger can choke on small pieces.

    2. Keep legos off of floor. If stepped on, it can cause intense pain.3. Legos consist of Cadmium. Acute exposure to cadmium fumes may cause flu like symptoms

    including chills, fever, and muscle ache

  • 8/3/2019 Eng300 Table Contents New3

    24/27

    Technical Writing Portfolio 19

    6.3 Analysis

    Audience: Rhoda Reynolds

    Memorandum

    TO: Rhoda Reynolds

    FROM: Jasmine Burroughs

    DATE: March 31, 2011

    SUBJECT: Develop Instructions

    There are a few ways the instructions can be improved. Instruction number 7 and 8 can be

    reworded for readers to better understand. The 5 pronged brick has to be placed next to a certain

    8 pronged brick. The tower is not supposed to be mentioned; unless its not in the title. Therewere some words that were confusing to readers. We told readers to both attach a prong and put

    it next to a prong. We have to let readers know which method we want them to attempt

  • 8/3/2019 Eng300 Table Contents New3

    25/27

    Technical Writing Portfolio 20

    CONCLUSION

    In conclusion, Technical Communication involves creating documents that readers can easily

    access and understand. Readers will be able to easily understand the information provided to

    them. There are also visual aids as well as tables to help guide readers and keep their attention.

    There is style sheets provided that help make these documents available for users. The memosprovided throughout this report allows readers to understand how the style sheets, instructions

    and projects were formatted.

  • 8/3/2019 Eng300 Table Contents New3

    26/27

    Technical Writing Portfolio 21

    RECOMMENDATION

    The Technical Communications course can also be an online based course. This course is called

    Technical Writing, but the course involves more than just writing. Students are creating

    instructions that will allow readers to put together an object. Every assignment has to betechnical. The information learned allows students to use it many types of careers. Students learn

    how to make an article as simple as possible for readers to navigate around. I was able to create

    memos to notify the progress of my work.

  • 8/3/2019 Eng300 Table Contents New3

    27/27

    Technical Writing Portfolio 22

    References

    Gur ak , L . J , & Lannon , J . M. ( 2010) . S t ra t eg i e s f o r Techn i ca l

    Com m uni ca t i on i n t he Workp l ace . Upper S add l e R i ve r : P ea r s on

    Educa t i on ,326- 330 .

    J enny Moy a s P hone a l s o has p i c t u r es .

    Johnson C. R. King R. C, Longman. J. A, McGuire, B. D. P ee r r ev i ew, au t hor s h i p ,

    e t h i c s , and conf l i c t o f i n t e r es t . ( 2007) . Journa l o f Nurs i ng Scho l arsh i p ,29 ( 2 ) , Re t r i eved f r om h t t p : / / on l i ne l i b r a r y.wi l ey. com/ do i / 10 .1111 / j . 1547-

    5069 .1997 . t b01551 .x / pdf .

    http://brickplayer.com/blog/wp-content/uploads/2008/07/minifig_full_bom.jpg

    http://a1.sphotos.ak.fbcdn.net/hphotos-ak-

    snc3/18151_252029723070_221852348070_3259117_3328652_n.jpg

    The link for the facebook Lego picture

    # HYPERLINK "https://ch1prd0202.outlook.com/owa/redir.aspx?

    C=fbbcaace474640c1b9760b45e7c54357&URL=http%3a%2f%2fupload.wikimedia.org%2fwikipedia%2fcommons%2fthumb%2ff%2ff2%2fAge_warning_symbol.svg%2f564px-

    Age_warning_symbol.svg.png" \t "_blank"http://upload.wikimedia.org/wikipedia/commons/thumb/f/f2/Age_warning_symbol.svg/564px-

    Age_warning_symbol.svg.png

    The warning picture.

    https://ch1prd0202.outlook.com/owa/redir.aspx?C=fbbcaace474640c1b9760b45e7c54357&URL=http%3A%2F%2Fbrickplayer.com%2Fblog%2Fwp-content%2Fuploads%2F2008%2F07%2Fminifig_full_bom.jpg%20%5C%20_blankhttps://ch1prd0202.outlook.com/owa/redir.aspx?C=fbbcaace474640c1b9760b45e7c54357&URL=http%3A%2F%2Fa1.sphotos.ak.fbcdn.net%2Fhphotos-ak-snc3%2F18151_252029723070_221852348070_3259117_3328652_n.jpg%20%5C%20_blankhttps://ch1prd0202.outlook.com/owa/redir.aspx?C=fbbcaace474640c1b9760b45e7c54357&URL=http%3A%2F%2Fa1.sphotos.ak.fbcdn.net%2Fhphotos-ak-snc3%2F18151_252029723070_221852348070_3259117_3328652_n.jpg%20%5C%20_blankhttps://ch1prd0202.outlook.com/owa/redir.aspx?C=fbbcaace474640c1b9760b45e7c54357&URL=http%3A%2F%2Fupload.wikimedia.org%2Fwikipedia%2Fcommons%2Fthumb%2Ff%2Ff2%2FAge_warning_symbol.svg%2F564px-Age_warning_symbol.svg.png%20%5C%20_blankhttps://ch1prd0202.outlook.com/owa/redir.aspx?C=fbbcaace474640c1b9760b45e7c54357&URL=http%3A%2F%2Fupload.wikimedia.org%2Fwikipedia%2Fcommons%2Fthumb%2Ff%2Ff2%2FAge_warning_symbol.svg%2F564px-Age_warning_symbol.svg.png%20%5C%20_blankhttps://ch1prd0202.outlook.com/owa/redir.aspx?C=fbbcaace474640c1b9760b45e7c54357&URL=http%3A%2F%2Fa1.sphotos.ak.fbcdn.net%2Fhphotos-ak-snc3%2F18151_252029723070_221852348070_3259117_3328652_n.jpg%20%5C%20_blankhttps://ch1prd0202.outlook.com/owa/redir.aspx?C=fbbcaace474640c1b9760b45e7c54357&URL=http%3A%2F%2Fa1.sphotos.ak.fbcdn.net%2Fhphotos-ak-snc3%2F18151_252029723070_221852348070_3259117_3328652_n.jpg%20%5C%20_blankhttps://ch1prd0202.outlook.com/owa/redir.aspx?C=fbbcaace474640c1b9760b45e7c54357&URL=http%3A%2F%2Fupload.wikimedia.org%2Fwikipedia%2Fcommons%2Fthumb%2Ff%2Ff2%2FAge_warning_symbol.svg%2F564px-Age_warning_symbol.svg.png%20%5C%20_blankhttps://ch1prd0202.outlook.com/owa/redir.aspx?C=fbbcaace474640c1b9760b45e7c54357&URL=http%3A%2F%2Fupload.wikimedia.org%2Fwikipedia%2Fcommons%2Fthumb%2Ff%2Ff2%2FAge_warning_symbol.svg%2F564px-Age_warning_symbol.svg.png%20%5C%20_blankhttps://ch1prd0202.outlook.com/owa/redir.aspx?C=fbbcaace474640c1b9760b45e7c54357&URL=http%3A%2F%2Fbrickplayer.com%2Fblog%2Fwp-content%2Fuploads%2F2008%2F07%2Fminifig_full_bom.jpg%20%5C%20_blank