Data Sheets: Analyzing the Genre and Structure - Prof. William Hart-Davidson, Study notes of Technical Writing

Download Data Sheets: Analyzing the Genre and Structure - Prof. William Hart-Davidson and more Study notes Technical Writing in PDF only on Docsity! Title TO:Bill Hart-Davidson, WRA 320 Instructor FR:Ryan Milewski DT:9/13/04 RE:Genre Analysis of Data Sheets HEY MAN – SUGGESTIONS WILL BE IN CAPS AND (). “LEAVE OUT” IN [ ]. Overview The main source for (OF?) information on any type of electrical component is the data sheet. These types of documents are used to inform whoever is trying to use a particular component on how to use the device without damaging it, (ITS) range of operation, and sometimes(,) suggested uses. Writers & Developers of the (genre) These documents are published by the company that sells any kind of electronic devices as (AS WHAT??? – MORE TO ADD? IF NOT, END SENT AFTER “DEVICES”) Audiences & Users of the (genre) Anyone trying to use an electrical component (FROM PROF ENGINEERS TO HOBBYISTS) will need to use a data sheet from [professional engineers to hobbyists – MOVE SEGMENT TO SUGGESTED PLACE IN SENT]. Format & Organization of the (genre) • General Description This first section is included in every data sheet. It briefly states what the component is intended to be used for and its features. (I’D COMBINE SENT 1&2: THE FIRST SECTION, INCLUDED IN EVERY DATA SHEET, BRIEFLY STATES WHAT THE COMP. IS INTENDED TO….” FOR BETTER FLOW) Since there are many different components that could be used to accomplish a specific task, (SIMPLE EXAMPLE WILL BE GOOD HERE, OR AFTER THIS SENT, FOR CLARITY ON TYPES OF “DIFF. COMPONENTS USED TO ACCOMPLISH SPECIFIC TASK” ) the general description will give the reader fast facts(, ) [to be able] (INSTEAD, ENABLING HIM/HER) to make a decision on the component. This could also be seen as an advertisement, since whatever company that sells the components is trying to get you to use their products (AGAIN, ANY EXAMPLES OF AD-LIKE WORDING OR GRAPHICS, TRYING TO CONVINCE READERS TO BUY?). • Equivalent Schematic A data sheet will sometimes include a schematic of the component that performs the same way, but (THIS IS) is not what is actually implemented inside the black casing. This (DOCUMENT) is to inform the user of the general idea of what is going on inside the component, but (NOT) [to] not actually reveal how it was made. Any electrical component is a product for some company, so it would not be desirable for the blueprints to be released (ELABORATE: EX: “….WHICH WOULD INCREASE THE RISK OF OTHER COMPANIES/INDIVIDUALS PIRATING THE INNERWORKINGS OF THEIR PRODUCT” TEACHERS LIKE CLARIFICATION). • Pin Description This is [also] (ANOTHER) [a] staple for any data sheet. Due to the small size, there is no way to mark [what] (WHICH) pins are what on a component. The pin descriptions will either have a drawing of the component with all of the pins labeled, or will have a table that lists the pins and what they do. Typically (,)for a more complex device, such as a microcontroller, pins will have more than one function. In this case(,) a table will be used to show what function will be performed on that pin during certain conditions. • Absolute Maximum Ratings This section will give the conditions that will destroy the component. For simple data sheets, this can be its own small section, but could be mixed in with other information as well. • Electrical Characteristics One of the main reasons for using a data sheet is to find out what kinds of signals should be connected to each of the components pins. This is usually shown as a large chart, and may be (A REFERENCE) for several different variations of the component. The values for each pin can be given as a range from minimum to maximum or as a typical value (AVERAGE VALUE? TYPICAL IS UNCLEAR HERE). These values given will ensure that the component will be in a safe operating range and will not damage it (WILL NOT DAMAGE COMPONENT, OR WILL NOT DAMAGE THE WHOLE SYSTEM? CLARIFY). There will also be a (“) units (“) column, since any kind of scientific number is useless without some sort of unit given (… TO IT, OR ASSIGNED TO IT, OR LABELING IT). • Typical Performance Characteristics Normally, this section will just include graphs of the outputs from the component. These graphs will compare two elements of the component against each other for a few variations (,) (USUALLY IN TEMP) [in temperature usually]. Since temperature plays a large role in how a component will perform, the component is tested under extreme heat and cold, [and] (AS WELL AS) at room temperature. This will [let the user be able to] (PERMIT THE USER TO) allow for variations in [their] (HIS/HER) circuit to account for the (ENVIRONMENTAL CHANGES) [change] that can not be [as] easily control[lable] (CONTROLLED). • Application Information This section is not always included in data sheets, but may be published as its own document. In most cases, a data sheet will have a section [that will be] devoted to building circuits with their component. The 555 timer data sheet (,) (FOR EXAMPLE,) has quite a few applications and the corresponding equations for [the] user(S) to customize it to whatever project they need. More complex components may have this type of information [spread around] (ORGANIZED) into specific sections. This is intended for the user to [be able to] implement the component without too much prior knowledge of the actual workings of it. Level of Formality in (genre) Data sheets are not written as wordy documents, [and closer to] (BUT STYLISTICALLY RESEMBLE) memos. These are intended to be used as fast facts that the user can pull out [just as if pulling out the component] (CONFUSING. MAYBE: AS EASILY AS PULLING OUT COMPONENT). Most of the (CORE INSTRUCTIONAL) information (IS) contained [is] in the pin descriptions, electrical characteristics, and application notes.