Technical Writing The Author Of This Report Chapter

PAGES
4
WORDS
1350
Cite
Related Topics:

Technical Writing The author of this report has been asked to answer several questions relating to the author's experience while learning about technical writing and similar subjects. The questions asked include what skills have been learned, what would be needed to continue learning the skills, how to keep improving those skills and so forth. Also asked for from this assignment include thoughts about the qualities that lead to efficacious technical writing, how the author of this report's work shows this, what has been learned about technical writing that is not apparent in the author's portfolio, what has been learned about communicating in the workplace, the author's contributions to the team's portfolio and the ways in which the author's perspective as a writer has changed. The portfolio includes the brochure for body weight index, the brochure regarding what to expect from working for an oil company, the PowerPoint relating to the safety and personal protection equipment and the job description of the entry-level operator.

Analysis

The author of this report has learned a good number of things in this class. The author has learned the lines that are drawn when it comes to what makes good writing and what makes less than optimal writing. The author of this report feels that the writing done nowadays is much better than it used to be. In comparing the author's work to that of established writers and article writers, the two are actually much closer to matching in terms of proper perspective and skill than was the case prior. However, there is still a gap of sorts here and there. It all comes down to keeping disciplined and staying true to the principles that any good writer should adhere to (Saha, 2013).

To continue improving skills, the author of this report would offer a few things. First, to improve and get better, the author of this report will have to keep writing and keep practicing. Skills...

...

Second, the author of this report will continue to pay attention to accepted standards, writing styles, citation standards and so forth so as to not get into bad habits that are against the scholarly precepts that should be followed. Third, the author needs to recognize that getting careless about words when doing technical writing is not acceptable. There has to be an absence of bias, an adherence to citation and sourcing standards, attribution to others for work that is borrowed or paraphrased and an absolute committal to not engage in any form of plagiarism, intentional or not (Saha, 2013).
When it comes to efficacy in technical writing, there are some common qualities that can and should be present at all times. First, the information and verbiage has to be in the proper order. It has to flow neatly from one topic or item to the next. The information must be accurate and timely. If the data in question is out of date or is applicable in certain contexts, then that needs to be accounted for in some way in the text. For example, if there is a feature in Windows 7 that was removed in Windows 8, that is a detail that needs to be included. If no distinction is made vis-a-vis what words apply to certain situations, the reader may assume (rightly so) that all modern versions of Windows operate this way. However, if this is not the case then the document needs to offer specificity about that so that no one gets confused. If a reader figures out that a document is inaccurate, the likelihood that they will trust and continue to use that document is not very high (Saha, 2013).

Something that the author of this report has learned that may not be apparent in the portfolio is that there are multiple perspectives when it comes to technical writing. One major example of this is how specific and technical to get. Of course, this matters a lot and it is based on the audience…

Sources Used in Documents:

References

Saha, S. (2015). Demystifying Technical Writing: 10 dos/don'ts for a technical writer |

Techgig. Techgig.com. Retrieved 23 April 2015, from http://www.techgig.com/knowledge/Demystifying-Technical-Writing-10-dos-don-ts-

for-a-technical-writer-3671


Cite this Document:

"Technical Writing The Author Of This Report" (2015, April 26) Retrieved April 26, 2024, from
https://www.paperdue.com/essay/technical-writing-the-author-of-this-report-2150104

"Technical Writing The Author Of This Report" 26 April 2015. Web.26 April. 2024. <
https://www.paperdue.com/essay/technical-writing-the-author-of-this-report-2150104>

"Technical Writing The Author Of This Report", 26 April 2015, Accessed.26 April. 2024,
https://www.paperdue.com/essay/technical-writing-the-author-of-this-report-2150104

Related Documents

The credibility of the cluster profiles was done with representative quotes from the qualitative data. This helped to support the labeling endeavor and strengthen the insights provided by the quantitative data. Data analysis The design for this study was founded upon independent coding of the open ended responses using a qualitative analysis software program, and succeeding principal components and cluster analysis. The first step entailed reading the open-ended responses and analyzing

Technical http://www.docdroid.net/m973/anreport.docx.html The title page of the document is formatted properly and attractively with the use of bold and different font sizes to allow ease of eye movement across the page, and the title page also identifies the author and date submitted. A table of contents is included, and it does use capital letters for all the major divisions of the report. Subheadings are also used. The content is fairly well developed

This was usually the case with the proliferation of British rule at the time; trade was the predecessor to British Colonialism. For administrative purposes, Singapore became a part of Penang and Malacca which were two other settlements in the region. By 1826 these areas were grouped together and became known as the Straits Settlement. Initially the centre of the Straits Settlement was Penang. Penang was governed by Calcutta and

Writing Program Curriculum Plan A brief Description of Students: The students are learners of English as a second language in a high school in Saudi Arabia. Learning Objects and outcomes: The knowhow of science Employ literary techniques to observe the phenomena of genetic ideas and in-vitro fertilization (Student's final work) To provide the students a comprehension about construction existing branches in science (Student's final work) Make use of science to work human related problems Analyze the factual data Analyzing

Functional and Technical Document File Name: Requirements Document.docx Original Document Created Original Document Created Original Document Created Document Reviewers/Approvers Position Reviewer Reviewer and Approver Sign-off Date Smith Joe Department Dean Smith Joe Underhill James Underhill James Jane Mary Accounting Officer Jane Mary Assumptions, Restrictions & Limitations Data Flow Customer Workflows As-Is Diagram and Actors To-Be Diagram and Actors Business and Functional Requirements Business/functional requirements Non-functional requirements Quality of Service Requirements Reliability System Availability Interfaces User Interfaces Software Interfaces Data Migration Interfaces Purchased Components Licensing Requirements Legal, Copyright and Other Notices Documentation Requirements User Acceptance Test Strategy Use Cases Use Case Use Case Metrics Security 17 20 Reports 17 20.1 General 17 20.2 Supplies Report 17 20.3 Supplies

Snort Author's note with contact information and more details on collegiate affiliation, etc. This report is my own work. Any assistance I received in its preparation is acknowledged within, in accordance with academic practice. For any material, from whatever source, quoted or not, I have cited sources fully and completely and provided footnotes and bibliographical entries. The report was prepared by me for this class, has not been submitted in whole or