Technical Writing in Computer Hardware Electronics

skilful Writing in Computer Hardwargon ElectronicsWhat is Technical Writing?Technical paper is a style of formal writing utilise in various fields as diverse as computer hardw ar and softw are, chemistry, aerospace industry, robotics, finance, consumer electronics and bioengineering. In short it is conveying specific nurture ab come to the fore a technological foul undefended to a specific auditory modality for a specific utilisation.Presentation of information is indeed in truth measurable as it dish break throughs the reader in solving a crabby worry or in understanding a accompaniment technology or crossroad. The words and graphics of good writing are meant to be serviceable i.e., they should be able aid in communicating in truthful terms a body of factual information that will help the hearing understand a subject or carry out a task.DDLCDDLC stands for document development life cycle it is a analogue collection of several somas that are used by a technical source to create a clear, concise, informative and well structured technical document. Conceptual knowledge of DDLC is crucial in creating good technical documents and at that placeby in achieving success in the field of technical writing.Various phases of DDLC areRequirement SpecificationThe Requirement specification phase is all to the highest degree content collection and content representation. It involves determiningAudience who is going to get ahead from this document or who is going to use the document?Time The m frame and various deadlines to be followed through the entire project amount of money/Number of pages The size or number of pages in the document.Tools The tools to be used for creating the document.Document type whether the doc is a user manual or help guide etc.Templates The guides and style guides to be used in preparing the documentReference Documents The reference documents client might provide to aid in the creation of the document.A lot of times t he, thewriter must normally interview the user as well as a subject matter estimable (SME) to get detailed information and to influence out what is essentialed or required. In the case of writing software documents the writer is supposed to interview or talk to the programmers and whereas to write active hardware, the writer talks to an engineer, technician or manager. The method of conducting the interview may vary from righteous talking with the person and taking down notes to tape recording the conversation. It is a good practice to have a list of questions on mint during the interviews with the SMEs or other technicians. Other sources include the internet, reference documents etc. The tools that are to be used in making the document are obdurate on the basis of the document type. For example, RoboHelp is used for creating online user guides and MS-Word is used in creating user manuals.Audience AnalysisThe complexity of a document is firm by the audience it caters to. Aud ience analysis phase involves determining the audience level. This push aside be done by every talking to the developers of the particular point of intersection or technology or through the SME. Also we can learn more about the audience level by talking to those the product is intended for. Formally, audience can be categorized into trine levels based on how much they already know about the product or the technology.Novice A novice user is completely in the buff to the technology or product the document is about and usually has very little or no knowledge about it. Documents intended for these kinds of audience need to contain everything about the technology starting from the very basics. ordinary A mediocre user has a general knowledge about what the product is all about but need toTechnical / Experts An expert or technical user has an in depth knowledge of the product , technology or software and is usually looking for only particular information.Product AnalysisProduct ana lysis phase involves deciding which of the dickens approaches presented below is more appropriate in writing about the technology / software.Menu drivenThematic approachDocument FlowThe spirit of this phase is creating an outline for the required document i.e., creating the skeletal framework of the document. A skeletal framework usually includes Preface or universe, Table of contents and figures, Chapter information and sequence, bibliography, index etc. All the elements of the document are tell serially to prepare the Table of Contents (TOC) . The output of this phase is to educate a clear view of how the document will be structured. aggregation InformationNow that the technical writer has a skeletal framework, he needs to gather the information required to fill in the blanks. For this purpose he needs to again communicate with the developers, SMEs and also find nearly of his own resources through the internet or the reference documents he is provided with. eldest DraftThis phase involves preparing the first selective service of the required document pursuance the pre approved document plan and time schedule.ReviewThe purpose of this phase is to review (self, match, technical, and final) the completed document against the requirements specification document, style guide and template determined during the requirements specification page.Peer reviewPeer reviewing is subjecting the authors work to the scrutiny of other employees who are experts in the same field. Peer reviews usually need a community of experts in the same field given field, who are qualified and can perform an impartial review. Even though there are a lot of speculations about peer reviewing, it actually encourages authors to impact the accepted standards of their discipline and also prevents the dissemination of irrelevant findings, unacceptable interpretations, personalized views and unwarranted claims.Technical reviewTechnical reviewing aids in creating a technically superior v ersion of the work product that is reviewed, which is done all by correction of defects or by recommendation or introduction of alternative approaches. Technical reviews are also a form of peer reviews but in which a team of qualified personnel examines the rightness of the document for its intended use and also identifies deviations from the mandatory specifications and standards. Technical reviews sometimes provide recommendations and examination of various alternatives.Editorial reviewEditorial reviewing aims at improving the readability of a disseminated sclerosis. The reviewer parses through the manuscript to find whether it can be further simplified or clarified. The reviewer either makes changes or makes marginal notes and a written report and then returns the manuscript to the writer for further revision.Second draftThe second and the final draft of the technical paper is out only after a final review. Once the document is free of any grammatical or technical related erro rs and follows all the guidelines, it is ready for publication.