Procedure Writer's Guide Effective TBD



Procedure Writer’s GuideEffective Date: TBDPrepared by: Bill EasleyProcedure Writer/Reliability SpecialistGretchen HollisSpecialist, Plant Configuration ControlStakeholder Review by: Tom Mundy _______________________________________________Manager, Plant Configuration ControlDate: __________Approved by: Garry Waggoner _______________________________________________Director, Engineering ServicesDate: _____________Dale Higginbotham _______________________________________________Sr. Director, Fossil Engineering and SupportDate: _____________Revision HistoryRevision NumberApproval DateNameDescribe/Justify Changes0TBDGretchen HollisInitial ReleaseTable of Contents TOC \h \z \t "Heading 1,1,Heading 2,2,Attachment,3" 1.Introduction PAGEREF _Toc283797011 \h 42.Purpose PAGEREF _Toc283797012 \h 43.Applicability PAGEREF _Toc283797013 \h 43.1.Recommended Software PAGEREF _Toc283797014 \h 44.General PAGEREF _Toc283797015 \h 55.Determining Level of Detail PAGEREF _Toc283797016 \h 56.Applying Emphasis PAGEREF _Toc283797017 \h 57.Using Action Verbs PAGEREF _Toc283797018 \h 68.Naming Components PAGEREF _Toc283797019 \h 149.Using Logic and Conditional Statements PAGEREF _Toc283797020 \h 1410.Writing Steps with Concurrent Actions PAGEREF _Toc283797021 \h 1611.Using Referencing and Branching PAGEREF _Toc283797022 \h 1612.Using Warnings, Cautions, and Notes PAGEREF _Toc283797023 \h 1713.Specifying Acceptance Criteria and Tolerances PAGEREF _Toc283797024 \h 1814.Best Practices for Writing PAGEREF _Toc283797025 \h 1914.1.Telling Your Readers What They Are About to Read PAGEREF _Toc283797026 \h 2014.2.Using People or Concrete Objects as Subjects PAGEREF _Toc283797027 \h 2414.3.Keeping the Action of Sentences in the Verb PAGEREF _Toc283797028 \h 2614.4.Using Words That Are Familiar to Your Reader PAGEREF _Toc283797029 \h 2714.5.Using Specific and Clear Language PAGEREF _Toc283797030 \h 2914.6.Creating Coherent Paragraphs PAGEREF _Toc283797031 \h 3115.Using the Right Word PAGEREF _Toc283797032 \h 3216.Punctuating Properly PAGEREF _Toc283797033 \h 3817.Frequently Asked Questions PAGEREF _Toc283797034 \h 4117.1.What are technical writers? PAGEREF _Toc283797035 \h 4117.2.When can I use all caps? PAGEREF _Toc283797036 \h 4117.3.Can I use an acronym at the beginning of a sentence? PAGEREF _Toc283797037 \h 4117.4.When should I use e.g. and i.e.? PAGEREF _Toc283797038 \h 4217.5.When do I use numbers and bullets to present items on a list? PAGEREF _Toc283797039 \h 4217.6.How do I use a comma with the last item in a series? PAGEREF _Toc283797040 \h 42PurposeThis Guide presents specific requirements and recommendations necessary to produce technically accurate and usable procedures, standards, policies, and other documents for Luminant Fossil Generation. The Guide is intended to align all of Luminant Fossil Generation to a fleet standard and to produce procedures and other documents that clearly and concisely transmit a message designed for a specific audience.The Guide applies to a variety of different procedures and document types; therefore, it is versatile enough to address the various situations and needs of these document owners and readers.Use the following guidelines to write more effective procedures. In general, these guidelines apply to all procedure types. However, some guidelines may apply specifically to one type of procedure and are indicated accordingly. ApplicabilityThis procedure applies to the following:Fossil Engineering and SupportLignite Plant OperationsGas Plant OperationsReferencesDevelopment references are documents used to develop the procedure. Performance references are documents referenced within the procedure.Development References*TVA*CPNPP*Luminant Operations Writer's GuidePerformance ReferencesLUM-FFA-ENG-0004 Procedure ManagementLUM-FFA-ENG-0005 Procedure DevelopmentLUM-FFA-REL-0018 Corrective Action ProgramDefinitions and AcronymsThe following definitions and acronyms listed below appear throughout this procedure. The first occurrence of each term and acronym appears in italics.<Type term or acronym>—<Use the Normal style and then the Bold style.> – <Type definition using complete sentences or spell out acronym><Use the Normal style.>ResponsibilitiesThe following individuals shall adhere to the key responsibilities listed below. The Configuration Controls Manager is responsible for maintaining the procedure current.<Position>InstructionsWhen writing procedural steps, ensure each step clearly conveys the intent without the need for the user to interpret. Each step should be a short, concise action statement rather than a long narrative sentence. It should be simple and convey only one idea. Use the following exceptions to normal sentence structure to help make your steps concise:Avoid using articles (i.e., a, an, the), unless required for clarity.Eliminate any unnecessary words not required to achieve clarity.Avoid using pronouns (e.g., you, he, they), since the user is understood.Avoid using synonyms or multiple terms for the same thing; be consistent with terminology throughout the procedure.Determining Level of DetailWrite procedural steps at a level of detail that is sufficient for the least qualified user. To accurately determine the level of detail that is needed, you may need to understand the training and qualification process of the user. In any case, more detail shall always be used in the following cases:for steps or proceduresSteps or procedures that call for infrequent tasksSteps or procedures where the consequences of errors or omissions are severeSteps or procedures that call for complex tasksSteps or procedures that call for tasks where past experience indicates the need for more detailApplying EmphasisWhen writing procedures, emphasize specific information to help the procedure user understand the instructions more clearly. To make emphasis more effective, use it sparingly and consistently. Follow the guidelines below to use the correct technique for each situation:Use italics for logic and conditional terms (technical procedures only).For all other situations requiring emphasis, use bold to make the information stand out to the procedure user. Avoid bold for text that should be emphasized with italics. Avoid italics for text that should be emphasized with bold. For example,8.2.3Notify system engineer or his designee to inspect the channel head interior, including channel partition. If tubes are unsatisfactory, then proceed to Section 8.3 or 8.4, as appropriate.Using Action VerbsWhenever possible, use action verbs to begin steps. Use simple, well-known and understood words. For example,8.4.1Cut shell diameter at cut point provided and marked by factory.Typical exceptions to beginning steps with action verbs are conditional statements and permissive steps (i.e., using may). For more information about conditional statements, refer to Section 1.31. Word your steps in the positive by stating what to do rather than what not to do. When negative statements are needed, place them in the step with which they are associated. For technical procedures, limit the number of verbs per step to one. However, you may use up to three verbs per step as long as they are related action verbs.The following list of verbs is not intended to be comprehensive. Verbs are selectedSelect verbs from this list where possible so that words have a meaning common to all performers. Avoid using terms that do not provide specific instructions unless they are followed by specifying information. Many of these verbs have similar meanings. Once a verb has been selected for a related series of action steps, use it consistently.Action VerbsUsageActuatePlace into a specific state of functional performanceExample: Actuate Phase AAdjustMake an incremental change or series of changes to arrive at a desired conditionExample: Adjust Line Level potentiometer R10 on front of relay fully counterclockwiseAlignArrange components into a desired configuration; to line up (e.g., index marks or shaft centerlines)Examples: Align the system for normal charging Align valves as appropriate Align matchmarks on coupling hubsAllowPermit a stated condition to be achieved prior to proceedingExample: Allow discharge pressure to stabilizeAssemblePut together what is required to provide an operational or functional capabilityExample: Assemble stern to plugBalanceAdjust several parameters at the same time at certain points in a system to specified values. Maintenance: Adjust equal forces around an axis, usually to reduce vibrationExample: Balance rotating element, maintaining minimum wall thickness of 0.100 inchBarricadeShut in or keep out with an obstruction; a tape or marker used to limit access to an areaExample: Barricade area below column No. 1 to prevent personnel from entering hazardous areaBlockInhibit a capability of a specific system or piece of equipmentCalculateTo determine by computation (computation method should also be identified)Example: Calculate maximum torque angleCalibrateCheck, adjust, or standardize a measuring deviceExample: Calibrate relayCheckNote a condition and compare with some procedure requirementExample: Check tank level—greater than 20%CleanTo rid of dirt, impurities, or extraneous matterExample: Clean any dirt or grease from actuator componentsCloseChange the physical position of a mechanical device. (Closing a valve prevents fluid flow. Closing a breaker allows electrical current flow).Example: Close the Channel 1 input switch and verify the following, as applicableCompleteAccomplish specified procedure requirementsExample: Complete first pass weldConnectJoin, fasten, or fitExample: Connect test equipment per Test Connect ElementaryConsultTo ask for advice, to take counsel; to refer toExample: Consult Plant StaffContinueMaintain or resume the performance of an activity or conditionExample: Continue with the procedureControlTo manually operate equipment as necessary to satisfy procedure requirements on process parameters such as; pressure, temperature, level flow.Example: Control tank levelCoverProtect or shelter equipment, or to place protective device to exclude harmful materialsExample: Cover open-ended pipes or flangesCycleA series of events or operations that recur regularly and usually lead back to the starting pointExample: Cycle pressurizer heatersDe-energizeRemove the supply of electrical power to equipmentExample: De-energize test equipmentDetermineTo find out,; to ascertainExample: Determine maximum venting timeDisassembleDismantle, take to pieces, or take apartExample: Disassemble outlet flange in accordance with work orderDisconnectSeparate or detachExample: Disconnect discharge hood quick disconnect fittings located just above fansDispatchTo send an equipment operator or other personnel to locally operate equipmentExample: Dispatch personnel to locally restore AC powerDisposeRemove from use (e.g., scrap)Example: Dispose of resin properlyEnergizeTo supply electrical energy to (something); commonly used to describe an electrical bus or other dedicated electrical pathExample: Energize AC busEnsureTo make sure or certain that a required condition exists, without regard to previous automatic or operator action. The contingency to establish the required condition is understood.Example: Ensure control valve is in autoEstablishTo make arrangements for a stated conditionExample: Establish normal tank pressure and level controlEvaluateTo examine and decide; commonly used in reference to plant conditions and operationsExample: Evaluate plant conditionsEqualizeTo make the value of a given parameter equal to the value of another parameterExample: Equalize charging and letdown flowIdentifyDetermine or make known the parameter, value, or condition as related to a procedure, or to mark/ or tag an itemExample: Identify the applicable sections or steps to be performedInitiateTo begin a processExample: Initiate flow to all tanksInsertPlace or position on object into another objectExample: Insert driver arm-connecting plate assembly into bodyInspectTo examine; to perform a critical visual observation or check for specific conditions; to test the condition ofExample: Visually inspect for leaksInstallFix or fit into equipment or a systemExample: Install lower diaphragm caseIsolateSeparate, set apart, seal off boundaryExample: Isolate XDCR w83 by removing pin 18LandReturn a lifted lead back to positionExample: Verify that leads have been landed and fuses installed.LiftDisconnect in the case of electrical leadsExample: Request that operations temporarily lift the LOTOV…LoadTo connect an electrical component or unit to a source of electrical energy. May involve a “start” in certain casesExample: Load the pump on the AC busLoosenRelease from restraint, cause to become less tightExample: Loosen handwheel setscrewLowerTo reduce or become less in magnitude; preferred usage in an action statementExample: Lower charging flow to restore pressurizer levelLubricateTo apply lubricant toExample: Lubricate diaphragm plate fastener (male) threads with Lubriplate MAG-1MaintainTo control a given plant parameter to some procedure requirement continuouslyExample: Maintain SG level in the narrow rangeMatchmarkCreate a distinguishing or identifying symbolExample: Matchmark and record As-Found stem connector position on actuator stemMeasureDetermine dimension, quantity or magnitudeExample: Measure both intake rocker arm bushings inside diameter and mating outside diameter of shaft.MinimizeTo make as small as possibleExample: Minimize secondary system contaminationMonitorSimilar to “check,” except implies a continuous activityExample: Monitor pipe temperature at least every 10 minutesOpenTo change the physical position of a mechanical device. (Opening a valve permits fluid flow. Opening an electrical breaker prevents current flow).Example: Open the manual valve.OperateTo turn on or turn off as necessary to achieve the stated objective.Example: Operate tank heaters to increase pressure.PerformCarry out specified actions or action stepsExample: Perform the followingPlaceTo put or set in a desired location or positionExample: Place controls in manual Place O-ring or gasket in position on yokePlace in StandbyTo return a piece of equipment to an inactive status but ready for start on demand; commonly used to refer to a mid-position on a switch labeled AutoExample: Stop the pumps and place in standbyPlugTo stop or insert somethingExample: Plug tee with 1 inch pipe plugRaiseCause to move up or increase position or valueExample: Raise charging flow to restore pressurizer levelRecordTo document specified characteristicsExample: Record average temperatureRemoveTo take off, move away or eliminateExample: Remove stem connector fasteners and stem connectorReplaceTo discard the existing item and to install an equivalent itemExample: Replace all rings if any one is not satisfactoryResetTo remove an active output signal from a retentive logic device even with the input signal still present; commonly used in reference to protection/safeguards logics in which the actuating signal is “locked in.” The reset allows equipment energized by the initial signal to be de-energized.Example: Reset Phase ARestoreTo re-establish an original conditionExample: Restore offsite power to AC safeguards bussesSampleTo take a representative portion for the purpose of examination; commonly used to refer to chemical or radiological examinationExample: Sample for secondary sideSetTo physically adjust to a specified value an adjustable featureExample: Set diesel speed to …rpmShut downTo de-energize equipment and place in standbyExample: Shut down unnecessary equipmentStartTo originate motion of an electrical or mechanical device, either directly or by remote controlExample: Start one BFPStopTo terminate motion of an electrical or mechanical deviceExample: Stop both diesel generatorsStrokeOperate a valve over its full travel; the travel time may be measuredExample: Fully stroke valve a minimum of five timesThrottleTo operate a valve or piece of equipment in an intermediate position to obtain a certain flow rateExample: Throttle charging flow control valve to establish desired flowTorqueApply turning or twisting force to a specified value; to tighten with a calibrated wrenchExample: Torque four bolts diametrically opposed 90 degrees apart to 120 inch poundsTransferTo shift or move a control to the desired positionExample: Transfer condenser steam dump to pressure control modeTripTo manually actuate a semi-automatic feature; to cause to fail or stopExample: Trip the turbine, trip a breakerTurn OnTo supply electrical energyExample: Turn on heatersVentTo permit gas or liquid confined under pressure to escapeExample: Vent pumpVerifyTo observe that an expected characteristic or condition exists. Typically, the expectation comes from some previous automatic or operator action.Example: Verify turbine tripAction Verb ChartNaming ComponentsComponent naming shall be consistent throughout each procedure and across all procedures. When you maintain consistent nomenclature in your procedures, you prevent the need for the user to make interpretations and, thereby, prevent misinterpretations.When writing operations procedures, specify components, controls, and indicators in operator terms by matching the names on control panels. These names could be engraved on the panel or displayed on a computer screen. For technical procedures, identify components by the tag number or name, or both as necessary, to match the nameplate. If a name does not exist on a control panel or nameplate, you can use the name from the equipment data in PR-ISM. For components that do not have a name in PR-ISM, and for controls and indicators that do not have an engraved name, use a name that is in common use and that is representative of the equipment. Use the following guidelines when writing names in your procedure:For names that match nameplates, use ALL CAPITAL LETTERS.For names not matching nameplates, use title case (capitalize first letter of each word in name).To avoid confusion with like components, include the location (i.e., panel, room, level, or building) in context with the name.Using Logic and Conditional StatementsLogic terms are and, or, and not. Conditional statement terms are if, when, and then. Use these terms to indicate the existing or expected state of conditions. When the user performs the step, it should be very clear what conditions are involved. Therefore, when you use these terms in procedural steps, emphasize them with italics. When you must address combinations of conditions, use the word and. If more than two conditions are involved, use a bulleted list, instead of and.Incorrect example:8.3.1Start RHR pump #1, safety injection pump #1 and centrifugal charging pump #1.Correct example:8.3.1Start all of the following components:RHR pump #1Safety injection pump #1Centrifugal charging pump #1In situations where you need to address alternate conditions, use the word or.Avoid using and/or as the logic can be ambiguous. Incorrect example:8.3.1Inspect shoes for abnormal wear and/or damage from excessive shaft movement.Steps that are contingent upon certain conditions or combinations of conditions should begin with a conditional statement starting with the word If or When and ending with a comma. In the remaining part of the sentence, you describe the action to be taken. For example:8.3.1If the line pressure exceeds 483 psi, open the relief valve.Use the conditional statement terms as follows:Use if to introduce a condition that may or may not occur.Use when to introduce a condition that is expected.Use then to introduce the action statement when additional emphasis is needed.Incorrect example,8.4.8A Condition Report should be initiated, if torque exceeds 16 foot pounds.Correct examples:8.4.8If torque exceeds 16 foot pounds, initiate a Condition Report.8.4.8If torque exceeds 16 foot pounds, then initiate a Condition Report. (additional emphasis)Conditional statements can be used for a condition that might occur sometime during a series of steps or during the performance of a specific activity. In this case, it is not known ahead of time exactly when the condition will occur. For this situation, you can write the step(s) as follows:Place the conditional statement in the earliest possible step where the condition can occur.Ensure the conditional statement clearly states how long the potential for condition occurrence is applicable (i.e., until what step or until the completion of what activity).Correct examples,8.1.2If pitting or corrosion is observed during pump disassembly, take photographs and document the event in a Condition Report.9.2.4If lube oil outlet temperature reaches 120 degrees F prior to Step 9.7, initiate CCW flow.When there are two possible conditions where each requires a different response, you can use if and if not to address each one. For example,8.2.1If an RCP is running, ensure RCS pressure is greater than 325 psig. If not running,ensure RCS pressure is greater than 250 psig.Writing Steps with Concurrent ActionsConcurrent actions are actions that are intended to be performed at the same time. When writing procedures, you should limit the number of concurrent actions within one step to the capability of and the number of users involved in the activity. Indicate concurrent actions using terms, such as following:WhileAt the same timeSimultaneouslyFor example,8.3.4Simultaneously open breaker 1EA1-1 and initiate Safety Injection by opening test switch S-1.Ensure that time or event dependent steps (i.e., actions that apply for a specific period of time or until another event occurs) clearly indicate what steps may or may not proceed until the time or event is achieved. If you do not state a limit or restriction, the user may proceed with subsequent steps.The following is an example with a restriction on subsequent steps:8.9.1While continuing, log bearing temperatures at 10 minute intervals for one hour. Donot secure pump until after completing temperature log.The following is an example without a restriction on subsequent steps:8.4.4While continuing, check shut vent valves every 15 minutes until piping cools to ambient temperature.Using Referencing and BranchingReferencing and branching are tools you can use to instruct the user to perform procedures and step series that are not in the home procedure. Referencing routes the user to the target procedure or step series. After performing the referenced instructions, the user returns to the original step in the home procedure. Branching routes the user to the target procedure or step series. After performing the branched-to instructions, the user does not return to the original step in the home procedure. When writing a home procedure that requires the performance of steps located in a target procedure, determine first whether the user should return to the home procedure or stop after performing the steps in the target procedure. Then, write a step at the appropriate point in the home procedure that references or branches to a target procedure. For referencing, use one of the following terms:Refer toUsingIn accordance withPerAn example of referencing is as follows,8.4.17Weld channel to shell in accordance with Work Order instructions.For branching, use one of the following terms when branching:Go toProceed toAn example of branching is as follows,8.7.5If temperature is already above 250 degrees F, proceed to Step 8.7.7.When using referencing or branching, observe the following guidelines,If the target instructions can be repeated in the home procedure without significantly increasing procedure length, then repeat the instructions and do not use referencing or branching. If the target instructions require more than a page, then use referencing or branching.When referencing within a procedure results in the repetition of steps, make provision for additional verifications and data recording, as necessary.Do not specify to perform steps in reverse order.Ensure that referencing does not result in an endless loop.Ensure that the referenced or branched-to procedure or step series is readily available for the user at the job site. If it is not available, consider including it in the home procedure.Using Warnings, Cautions, and NotesDuring procedure development, you may need to call the user’s attention to critical steps (steps with potential hazards) or important information. Warnings, Cautions, and Notes enable you to highlight this information for the user. Include each type as necessary in your procedure for the following situations:Warning – Used to call attention when death or injury are a potential result of the action about to be taken, if performed improperly. Caution – Used to call attention when damage to equipment is a potential result of the action about to be taken, if performed improperly.Note – Used to call attention to useful information or additional information.Use the following guidelines when adding Warnings, Cautions, and Notes to your procedure:Do not include mandatory action statements in your Warnings, Cautions, and Notes. Mandatory action is reserved for steps. You may include permissive statements (i.e., “may” statements) in your Notes provided no verification, data recording, or other handwritten documenting is associated with the note.Place Warnings and Cautions immediately prior to the step(s) to which they apply.In general, place Notes immediately prior to the step(s) to which they apply. If it makes more sense to place a Note immediately after a step and is not required prior to the step, then it may be placed after the step.When a combination of Warnings, Cautions, and Notes apply to the same step or steps, position the Warnings first, then the Cautions, and finally, the Notes.Specifying Acceptance Criteria and TolerancesYou should include acceptance criteria in steps that require meeting a condition before proceeding to the next step. Acceptance criteria may be quantitative or qualitative: however, quantitative criteria are preferred. Qualitative criteria typically involve an event or a change of state. For example:8.4.3Adjust R-11 CCW until light PL-401 goes OFF.Quantitative criteria include measurements. The same action above can be written using a quantitative criteria as follows:8.4.3Adjust R-11 CCW until light PL-401 goes OFF. Verify voltage at J-1 to be 4.90 mv (4.89 to 4.91).You should establish positive and definite acceptance criteria. Some examples are:Sounding an alarmTurning lights on or offChanging a contact stateInstalled meter indicationTest equipment indicationStarting a motor, pump, or other componentActuating a valve, actuator, or moving other componentsAcceptance criteria shall be consistent with source documents, unless an evaluation or other justification has been provided.When you have quantitative acceptance criteria, specify the measurement with tolerances where possible. Give a nominal value, if applicable, and ranges in immediately understood terms to avoid the need for interpretation. For tolerances with nominal values, specify the nominal value followed by a range of acceptable tolerance within parentheses. For example,8.9.1Adjust resistor current to 4 ma (3.99 to 4.01).When a nominal value is not applicable, just write the range as follows:8.9.1Adjust resistor current to between 3.99 to 4.01 ma.In general, specify tolerance values in a manner that is consistent with the associated instrumentation or equipment units. More specifically, make sure the value precision is consistent with the precision to which the associated instrument is capable of measuring. Normally, the most precision a user can obtain is one-half the distance between graduated markings. Using the example of a tank level gauge showing 2 percent increments, the following provide guidance for how to write the tolerances:Correct example:6.3.7Raise tank level to between 67 to 70 percent.Incorrect example:6.3.7Raise tank level to 67.5 to 70 percent. Best Practices for WritingYour goal while writing documents should be to provide your readers with information they can understand easily and accurately. So, while these guidelines help you be a more effective writer, they also help your reader be a more effective reader. But I’ve used correct grammar. Isn’t that enough?While using correct grammar is essential to writing effectively, you can create even more effective documents by looking at other elements of writing in addition to grammar. The following guidelines can help take your writing from good to great:Tell your readers what they are about to readUse people or concrete objects as subjects XE "subjects" Keep the action in the verb XE "action" Use words your readers already knowUse specific and clear languageGuide your reader through unfamiliar informationUse the tips from the FAQ at the end of this documentTelling Your Readers What They Are About to ReadWhen readers access your documents, they want to know what they are about to read. While you understand the purpose of your documents and its individual paragraphs, your readers initially may not. So, to avoid confusing your readers, explicitly tell them what information they are about to read at both the beginning of the document and throughout the document’s paragraphs. Introduce your documentIntroduce your document to tell your readers the document’s overall purpose and what sections it contains. When you tell your readers about the document’s overall purpose, you prepare them for the detailed information they will read in the individual sections. For example, look at the introduction of Using Best Practices XE "Best Practices" for Writing. The introduction tells you the document’s purpose and what topics it addresses, which allows you to better understand and apply the information you are reading now. When your document lacks an introduction XE "introductions" , your readers may not fully understand the document’s detailed information or how the document may apply to them.Use topic sentences at the beginning of paragraphsUse topic XE "topic" sentences at the beginning of paragraphs to tell your readers what topic each paragraph discusses. Topic sentences contain adequate information that helps readers interpret the paragraph’s remaining sentences. When paragraphs lack topic sentences, readers have difficulty understanding the meaning of paragraphs. Look at the example below.BeforeAfterThey may not find the reason why it has accumulated in areas outside the CDMP. If so, they need to reclassify the areas. They should use Luminant’s procedures to clean the dust.Sometimes site personnel will find dust outside the areas covered in the CDMP. However, they may not find the reason why the dust accumulated in those areas. If so, they need to reclassify the areas. They should use Luminant’s procedures to clean the dust.The first sentence of this paragraph is vague. XE "topic" Who is “they”? What is “it” that has accumulated? Readers will find this paragraph difficult to understand because they do not know its topic.This topic XE "topic" sentence contains specific information that clearly tells readers the paragraph discusses site personnel and dust. Now the paragraph is much easier for readers to understand because the topic sentence prepares them for the sentences that follow.Using Topic SentencesIntroduce new sectionsIntroduce new sections to tell your readers how each section fits in with the rest of the document. When readers understand how the pieces of a document fit together, they can better interpret or understand what to do with the information found within its sections. Look at the example below.BeforeAfter4. Procedures XE "Procedures" 4.1 SetupAppendix A shows the latest turbine cycle heat balance of this unit.? This test acquired temperature and/or pressure readings from all flow paths, which are shown as the arrowed dash or solid connection lines in the heat balance diagram.? 4.2 TestingA test point is a plant pre-installed apparatus, either a thermal well or a plant pressure transmitter extraction line with valves.?4. Procedures XE "Procedures" This section shows how we set up and tested the turbine cycle heat balance.4.1 SetupAppendix A shows the latest turbine cycle heat balance of this unit.? This test acquired temperature and/or pressure readings from all flow paths, which are shown as the arrowed dash or solid connection lines in the heat balance diagram.? 4.2 Testing A test point is a plant pre-installed apparatus, either a thermal well or a plant pressure transmitter extraction line with valves.?The sections Setup and Testing lack an introduction that tells readers how these sections fit in with Procedures XE "Procedures" or how the sections relate to each other. Consequently, readers may not understand how to interpret or use the information in these sections.By introducing the Setup and Testing sections, readers now understand the sections’ purpose and what information they contain.Introduce New SectionsIntroduce listsIntroduce lists to prepare your readers for the items they will find in the list. When you introduce lists, you tell your readers how the list fits in with the rest of the paragraph, which helps them interpret the list’s meaning. Look at the example below.BeforeAfterFuel-Handling Equipment chartFuel flow elementsElectrical ignition sourcesMechanical heat sourcesSafety equipmentFuel-Handling Equipment chartYou will find the following items on the Fuel-Handling Equipment Chart. You must maintain and inspect this equipment in areas where your site personnel handles fuel.Fuel flow elementsElectrical ignition sourcesMechanical heat sourcesSafety equipmentWithout an introduction, the items in this list lack meaning. Readers may not understand the items’ purpose or how the items in this list relate to the Fuel-Handling Equipment Chart.The introduction before the list provides readers with information that explicitly states the purpose of the items in the list. Now readers can gather meaning from the list. Introduce ListsWhen you present items in a list, use either numbers XE "numbers" or bullets XE "bullets" . Use numbers when the list needs to convey a sequential order or hierarchy, like steps in a procedure. Use bullets with the items in the list that do not imply a sequential order or hierarchy, like the example above.Using People or Concrete Objects as SubjectsUse people or concrete objects as subjects XE "subjects" of the sentence to directly tell your readers who or what the sentence is about. When you tell readers who or what the sentence is about, you provide them with direct information that lessens ambiguity XE "ambiguity" in your sentence’s meaning. So, when you can, use people as the subject of your sentences. Look at the example on the next page.BeforeAfterIdentification of plant problems will help resolve adverse trends.The site manager should identify plant problems to help resolve adverse trends.Most readers find this sentence ambiguous because the subject “identification” is not a person; the sentence does not tell readers who should identify plant problems.Readers understand this sentence more easily because it uses the person “manager” in the subject position XE "subject position" . Readers now directly understand who should identify plant problems.Using a Person as the SubjectLet’s look at another example.BeforeAfterIt is recommended that all FMEAs be reviewed by the team using the FMEA module in Meridium. The team should review all FMEAs by using the FMEA module in Meridium.Who should review the FMEAs? The subject “it” lacks information to tell readers who should review FMEAs.By using “FMEA team” as the subject, this sentence clearly states who should review FMEAs.Using a Group of People as the SubjectSometimes you may write about a topic XE "topic" that does not include people. If you cannot find a person to make the subject, use a concrete object capable of performing the action XE "action" of the sentence. Look at the example below.BeforeAfterThe purpose of this document is to provide the process specification for the Corrective Action Program.This document will provide you with the process specification for the Corrective Action Program.The subject purpose is incapable of performing the action XE "action" of the sentence—to provide. This sentence does not contain a person to use as the subject, so we must use a concrete object able to provide the process specification for the Corrective Action Program.Although the subject document is not a person, it is a concrete object capable of performing the action XE "action" of the sentence.Using an Object as the SubjectIf you are able to use either a person or a concrete object in the subject position XE "subject position" , always choose the person.Keeping the Action of Sentences in the VerbKeep the action of the sentence in the verb to create direct information your readers can easily understand. Readers expect to find the action XE "action" of a sentence in the verb XE "verb" . This may seem obvious, but sometimes writers put the action in other positions of the sentence, such as the noun position. When writers place action in noun positions, they create abstract sentences that are difficult for readers to understand. Therefore, keep the action of the sentence in the verb to create direct information your readers can easily understand. For example:BeforeAfterWhen there is a discovery of a problem, we will initiate a CAP document for evaluation and problem resolution.When we discover a problem, we will initiate a CAP document to evaluate the problem and find a way to solve it.Most readers will find this sentence abstract and difficult to understand because the sentence uses verbs in its noun positions. To create a more concrete sentence, shift the action XE "action" of the sentence into the verb XE "verb" position.When we shift the action XE "action" from the nouns into the verbs, the sentence provides more direct information that readers easily grasp.Keeping the Action of the Sentence in the VerbLet’s look at another example:BeforeAfterThe program scope will include establishing and implementing a process for initiating corrective actions before unexpected failure of critical equipment.The program scope will require us to establish and implement a process to help us initiate corrective actions before critical equipment unexpectedly fails.This sentence contains action XE "action" buried in the noun positions that readers find abstract and difficult to grasp. Readers may need to read this sentence several times to understand its meaning.By putting the action XE "action" back into verbs, this sentence provides readers with concrete information they can easily understand.Keeping the Action in the VerbUsing Words That Are Familiar to Your ReaderYou can help readers understand information in your documents quickly and effortlessly if you use familiar words. When you use words readers are unfamiliar with, they may become distracted from what they are reading and take extra time to understand the meaning of the sentence.Use simple wordsUse simple words so your readers process information easily. Avoid using inflated words that distract your readers. Instead, use words your readers will find simple to read. For example:BeforeAfterWe will distribute reports to all personnel cognizant of the root cause analysis.We will distribute reports to all personnel who are aware of the root cause analysis.Using Simple WordsLet’s look at another example:BeforeAfterThe POC will utilize the monitoring facility to support the program.The POC will use the monitoring facility to support the program.More on Using Simple WordsUse consistent words and acronymsUse consistent words and acronyms for the same topic XE "topic" so your readers understand which topic you are referring to throughout your document. If you use multiple terms for the same topic, your readers may think you are writing about a variety of topics when you are referring to only one. So, when you refer to topics such as equipment, programs, or departments, choose one term or acronym for the topic and use it consistently throughout your document. Look at the example below.BeforeAfterPlants must set up the Coal Program that is specific to their sites. At the plant, managers will be responsible for specific tasks to ensure each plant is properly following the CDMP. The coal management program will help prevent hazards created by coal.Plants must set up the Coal Dust Management Program (CDMP) that is specific to their sites. At the plant, managers will be responsible for specific tasks to ensure each plant is properly following the CDMP. The CDMP will help prevent hazards created by coal.Notice the paragraph uses three different terms to addresses one topic XE "topic" (the Coal Dust Management Program). Consequently, readers may think the paragraph is discussing three different ideas instead of one. Because the paragraph’s sentences use CDMP consistently, readers will understand that the paragraph addresses one topic XE "topic" only.Using Consistent Words and AcronymsWhen you address an acronym for the first time in a section, include the words it represents (like in the After example above). This helps your readers identify the meaning of the acronym. Then, in the sentences that follow, use the acronym only. Using Specific and Clear LanguageWhen you use specific and clear language in your documents, your readers will better understand the meaning of your sentences. Specific and clear language helps eliminate ambiguity XE "ambiguity" that causes your readers to ask questions about the document’s information.Provide your reader with detailsProvide your reader with details that help them fully understand what you are trying to tell them or what they should do. Look at the example below.BeforeAfterIf you cannot start the conveyor, action XE "action" should be taken as soon as possible to protect the conveyor.If you cannot start the conveyor, tell the Operator immediately so you can protect the conveyor.Readers may ask, “What ‘action XE "action" ’ should I do? How soon is ‘as soon as possible?’” Now readers know what they should do (tell the operator) and when they should do it (immediately).Provide Your Reader with DetailsProvide your reader with specific language XE "specific language" especially when the topic XE "topic" discussed in the paragraph deals with a situation in which a person may be harmed or equipment may be damaged, like in the example above.Avoid stacking nounsAvoid stacking nouns to prevent ambiguous language in your sentences. You create stacked nouns XE "stacked nouns" when you write at least three nouns back-to-back, which modify each other. Stacked nouns confuse your readers because they create dense sentences that are difficult to read. Look at the example below.BeforeAfterStation manuals include fossil plant procedure manuals that outline the plant’s activities.Station manuals include procedure manuals that outline activities at the fossil plants.The stacked nouns XE "stacked nouns" Fossil plant procedure manuals create a dense sentence that readers find difficult to interpret. This sentence breaks up the stacked nouns XE "stacked nouns" , which helps readers more easily read through the sentence. Avoid Stacking Nouns Where PossibleUse positive language XE "positive language" Use positive language XE "positive language" so readers can easily comprehend your sentences. When you use negative language XE "negative language" , your readers must take more time and work harder to interpret the meaning of your sentences. Readers would rather know what to do instead of what not to do and, similarly, what something is instead of what something is not. Look at the example below:BeforeAfterThe procedures that are not used more than two years should be reviewed no less than every two years.The procedures used less than two years should be reviewed at least every two years.Because of the negative language XE "negative language" not and no, readers struggle to interpret this sentence and may reread it several times to understand the meaning.Readers can now easily gather the meaning of this sentence because it uses positive language XE "positive language" to identify what kind of procedures should be reviewed and when those procedures should be used.Use Positive LanguageSometimes you may have to use negative language XE "negative language" ; however, when you can, use positive language XE "positive language" . Creating Coherent ParagraphsReaders will use your documents to gather new information that is unfamiliar to them. Write paragraphs in a way that guides the reader through unfamiliar information. Start the paragraph by writing an effective topic XE "topic" sentence (see Section 5, REF _Ref268697425 \h Telling Your Readers What They Are About to Read). In the sentences that follow, use the old/new pattern XE "\“old/new\” pattern" .The old/new pattern XE "\“old/new\” pattern" allows you to establish a logical flow in your paragraphs that guides readers through the information. In the first half of your sentences, use old information. Old information consists of words and phrases already used in the paragraph. In the second half of the sentence, use new information. New information consists of words and phrases that have not yet been used in the paragraph.By presenting old information first, you introduce your readers to new, unfamiliar information in the second half of your sentences, which smoothly connects the sentences together and establishes a logical flow in the paragraph. Look at the example below (new information is shown in bold):BeforeAfterWhen we identify plant problems, we support a wide variety of trending opportunities. The accurate characterization of events and issues will contribute to the timely identification and resolution of adverse trends. Fleet-level event trend codes will be developed and implemented for this purpose. Employees will be trained to select trending and program codes in a consistent manner.We must identify plant problems to support a wide variety of trending opportunities. When we identify plant problems, we must accurately characterize events and issues, which will help us identify and resolve adverse trends. To effectively identify adverse trends, we will develop fleet-level event trend codes that employees will be trained to use in a consistent manner.Readers become stuck when they see new information at the beginning of these sentences. The new words break the flow of the paragraph and readers struggle to efficiently read through it. At the beginning of the sentences, readers see old, information they have already read in the paragraph, which guides them into the new, unfamiliar information. Now readers can easily read through the paragraph because the old/new pattern XE "\“old/new\” pattern" has established a flow by linking the sentences together.Using Old and New InformationThe topic XE "topic" sentence will contain all new information because it is the first sentence of the paragraph. Therefore, the old/new pattern XE "\“old/new\” pattern" starts in the second sentence of the paragraph. Using the Right WordThe following material is an alphabetical list of words commonly misused in technical writing with their correct definitions.WordsDefinitionsAccuracyor precisionAccuracy is the agreement between the true value and the result obtained by measurement. Precision is the agreement among repeated measurements of the same quantity.Activateor actuateBoth words mean to make active, although actuate is usually applied only to mechanical processes.Example: The relay actuates the trip hammer.Affector effectAffect is a verb that means to influence.Example: The Commission’s decision affected all licensees.Effect can function either as a verb that means to bring about or to cause, or as a noun that means a result.Examples: The Chief effected several changes in the Branch that had a good effect on morale.Avoid using effect as a verb. A less pompous-sounding substitute, like made, is preferable.Alternate or alternativeTo alternate (verb) is to occur in successive turns. An alternative (noun) is a choice among mutually exclusive objectives or courses of action.Analyze or determine or identifyTo analyze is to separate into parts to determine the nature of the whole.To determine is to ascertain definitely, as after an investigation or calculation.To identify is to name a thing, to ascertain its origin, nature or characteristics.And/orAvoid this expression. State your meaning exactly.Change: Submit X and/or Y with your application, as appropriate.To: Submit X or Y or both with your application, as appropriate.Assure or ensure or insureThese words all mean to make secure or certain. Assure refers to persons and it alone has the sense of setting a person’s mind at rest.Example: The health physicist assured the concerned public that there was no risk of exposure to radiation from the normal operation of the proposed plant.Both ensure and insure mean to make secure from harm. However, only insure has the connotation of guaranteeing life or property against risk and should be reserved for use only in this sense.Example: A closely followed inspection schedule will ensure proper operation of the monitoring instruments.Because or sinceBecause is the strongest and most specific connective used to state a causal relationship.Example: He was kept under observation because his dosimeter indicated exposure to radiation.Since is a weak substitute for because when expressing cause. It is, however, the appropriate connective when the emphasis is on circumstances or conditions rather than on cause and effect.Example: Since all of the inspections proved the plant to be operable, the proposed startup schedule was pose or comprise or consist or includeCompose means to create or to make up the whole of something. Parts compose (make up) a whole.Example: Cement, aggregate, and water (the parts) compose concrete (the whole).Concrete is composed of cement, aggregate, and prise means to embrace or to include. The whole comprises the parts.Example: A botanical garden (the whole) comprises trees, flowers, and other plant life (the parts).Consist means that all parts making up a whole are listed, but include does not.Example: Concrete consists of cement, aggregate, and water. Concrete includes cement and aggregate.Conclude or decide or determineTo conclude is to decide or judge after careful consideration. To decide is to make up one’s mind, as after doubt or debate. To determine is to establish or ascertain definitely.Continual or continuousContinual means intermittent or repeated at intervals. Continuous means without interruption in time, or of unbroken extent in space.DataIn procedures, data may be used as a singular or plural noun, depending on the intended meaning. Do not use data generically when a more specific term, such as compilation, list of values, physical dimensions, experimental observations, or numerical results would be more precise. The singular form of data, datum, is seldom used except in surveyor’s terms like datum line and datum plane.Due to or because ofDue to in the sense of caused by is acceptable in phrases following a verb form of “to be.”Example: His fall was due to carelessness.Due to is not acceptable when it follows other verbs and is used to mean because of.Change: He fell due to carelessness.To: He fell because of carelessness.FactorFactor has a precise mathematical meaning. Do not use it unnecessarily even in mathematical contexts, however. The expression to increase by a factor of 3 means simply to triple. Use triple.Farther or furtherFarther refers to distance. Further indicates additional degree, time or quantity.Example: As you go farther away, your ability to hear is further decreased.Fewer or lessFewer refers to units or individuals. Less refers to mass or bulk.Example: With the use of less powder, fewer particles result.Foreward or forward or prefaceForward is very often confused with foreword. Even though forward describes a position of something located toward the front, it is not the correct word to describe introductory material in a report. The term foreword usually applies to a statement about a book or report written by someone other than the author. A preface is usually a statement by the author that describes the purpose, background or scope of a book or report. The terms foreword and preface are often used interchangeably.i.e. or e.g.i.e. means that is. E.g. means for example. Always follow these terms with a comma. Use for example at the beginning of a sentence. Use e.g., within a sentence or within parentheses. ImpactImpact used as a noun means the actual striking of one body against another or the impression of one thing on another. Impact used as a verb means to cause to strike forcefully. Do not use impact where you mean affect.Imply or inferImply indicates by association or consequences rather than by direct statement.Example: The neatness of the report implies that the typist is proud of his work.Infer derives a conclusion from facts or premises.Example: We infer that the hyphenation is correct.Interpolate or extrapolateYou interpolate (meaning estimate) between two known values. You extrapolate (meaning infer or predict) from the values of a known series.Mutual or commonMutual refers to two persons or things and means reciprocally exchanges. Common means shared by all. On the order ofDo not use on the order of to mean about or approximately. If you mean within the order of magnitude, say so.OnlyPlace only immediately before the word or phrase it modifies. Note the difference in meaning caused by the word’s location in the following sentences:Example: He was the only engineer. He was only the engineer.Opposed to or compared toDo not use opposed to unless you mean in literal opposition to; use compared to instead.Example: Force “A” is opposed to force “B” and is stronger. Force “A” compared to force “B” is several times greater.Order of magnitudeUse this phrase to express measurements in powers of 10 only, not to mean approximately.Example: The earth’s mass is about 10^24 kg; that of the sun, 10^30 kg. Their masses differ by about six orders of magnitude.Parameter or propertyA parameter is any specific quantity or value affecting or describing the theoretical or measurable characteristics of a unit being considered which behaves as an independent variable or which depends upon some functional interaction of other quantities in a theoretical determinable manner.Example: The parameters for the first test were 6 to 12 V. Four parameters, three in space and one in time, are needed to specify an event.A property is an explicit value or characteristic.Example: One of the most important properties of iodine is its low temperature of sublimation.Practical or practicablePractical means useful in actual practice. Practicable means capable of being put into practice.Presently or currentlyPresently means in a short time, soon, directly. It does not mean now or at this time. To denote now, use currently.Principal or principleAs a noun, principal means head or chief; as an adjective, it means highest or best. Principle means basic truth, law or assumption.Prior or beforePrior is an adjective meaning earlier in time or order. Before as an adverb means in advance; as a preposition, it means in front of or preceding.Example: He has hired according to prior agreement, an agreement reached before his arrival.ProcureProcure is an overworked word. Buy, get or purchase is preferred.Proved or provenProved is preferred as the past participle of the verb to prove.Example: He has proved his point.Proven is better used as an adjective.Example: He has a proven record of achievement.Providing or ifDo not use providing in place of if.Example: Providing jobs is difficult now, but will be easier if next year’s budget is adequate.Shall or should or mayShall indicates a mandatory requirement. Should indicates a preferred way of doing something. May is used when two or more alternatives are acceptable.That or whichThat is appropriate to essential (defining) clauses that are not set off by commas. Which is appropriate to nonessential (nondefining) clauses that are always set off by commas.Examples: These frequencies, which increase exponentially with voltage, can cause perturbations that are self-propagating.ViaVia is Latin for by way of. Restrict its use to routing instructions. Do not use via to mean through or as the result of outside of these contexts.Example: The package was sent to Bethesda via Region I.Whether or ifWhether implies a condition of doubt.Example: He was not sure whether security was breached.If implies no alternative.Example: If it does not rain, we will move the equipment.While or although or whereasThe noun while, when used in adverbial phrases, indicates a period of time (during, or at the same time as). When used as a conjunction, while means as long as in reference to time. While should not be used in the place of although, whereas or but. Although (conjunction) means regardless of the fact that or even though. Whereas (conjunction) means in view of the fact that and is commonly used to indicate a comparison or contradiction.Word Guide Punctuating ProperlyPunctuation marks are listed alphabetically below, with examples of correct usage.Punctuation MarksUsageApostropheUse an apostrophe to indicate possession (supervisor’s desk). An apostrophe is used to indicate a contraction (can’t, don’t, it’s). Do not use contractions in procedures. Avoid the use of apostrophes to indicate plurals, especially acronyms. Example: ABCs, not ABC’s.Most plural possessives are formed by adding s’ to the end of the noun.Example: The supervisors’ desks were located in the office. For plural nouns not ending in “s,” add ‘s.Example: The triplets’ clothing was found in the children’s department.BracketsUse brackets as special step designators. For other applications, use parentheses where possible.ColonUse a colon to indicate a series or list.Example: Verify the following valves are open: 1-8110, CCP 1 & 2 MINIFLO VLV 1-8111, CCP 1 & 2 MINIFLO VLV 1-8483A, 1-FCV-121 UPS TRM ISOLUse a colon to indicate ratios or proportions. Avoid the use of ratios, if maUse a comma to set off an introductory clause or phrase. Always use a comma after the “if” clause in a conditional statement.Example: If battery voltage <200 VDC, record voltage reading in Table 1.Use a comma to separate elements for clarity or emphasis. You may use a comma to separate items in a series. Include a comma before “and” at the end of a series.Example: Open Breakers 6, 8, 10, and 12 locally.Use a comma to separate five or more digits (10,000 ppm).DashDo not use the double dash.EllipsisUse … to denote omission of a word or words.Exclamation pointDo not use the exclamation point!HyphenUse a dictionary as a guide for determining those words that must be hyphenated. Use hyphens to indicate syllable breaks where a word must be carried over from one line to another. Wherever possible, avoid breaking words.Use a hyphen in compound words with “self” (self-explanatory). Use a hyphen when two or more words express a single consent.Use a hyphen when a letter is linked with a nounExample: X-ray, O-ring, u-boltSeparate chemical elements and their atomic weight with a hyphen (Uranium-235, U-235).When large numbers must be spelled out to connect a word ending in –ty with another word, use a hyphen (ninety-five).Use a hyphen when fractions are spelled out (one-half, one-third).Do not hyphenate words with the following prefixes unless misleading or awkward letter combinations result:-pre-micro-post-mini-re-multi-sub-non-superUse a hyphen if it appears in component numbers.ItalicsUse for special purposes only.ParenthesisUse parentheses to set off explanatory or supplementary information.Example: Sodium hydroxide (NAOH)Specify acceptable ranges in parentheses following a desired or nominal value.Example: 100 psi (96 to 103)Use parentheses to set off a graphical reference callout following parts and equipment in procedure text.Example: Remove O-ring (2)PeriodUse a period to indicate the end of a sentence.Example: Verify Containment Pressure is below 3.0 psig.Use a period after initials (L. Flagg). Do not use periods in acronyms (QA, not Q.A.) or abbreviated units of measure (lb, not lb.)Exception: Use “in.” for “inch.”Question markDo not use the question mark in procedure text. Use the question mark at decision points (in flowcharts).Quotation markUse quotation marks to set off annunciator legends and computer messages.Example: “DIESEL GEN SUMP A HI LVL”Use quotation marks to acknowledge specifically reproduced material.Example: 10DFR50, Appendix B, states, “Instructions, procedures or drawings shall include appropriate quantitative or qualitative acceptance criteria for determining that important activities have been satisfactorily accomplished.”SemicolonAvoid the use of semicolons where there is an implied condition.Change: The output LEDs may not turn on or off at the proper voltage; adjust the setpoint or deadband until the proper LED actuations are attained.To: If the output LEDs do not turn on or off at the proper voltage, adjust the setpoint or deadband until the proper LED actuations are attained.Minimize the use of semicolons to punctuate compound sentences in procedures.Change: Analyze all data within 96 hours; verify head vs. flow data fail within range indicated on Enclosure 13.5.To: Analyze all data within 96 hours. Verify head vs. flow data fall within range indicated on Enclosure 13.5.SlantsUse slants with units of measure.Example: lb/hrPunctuation Usage Chart Frequently Asked QuestionsThe following are common questions asked about documents and writers.What are technical writers?Technical writers create, write, design, or maintain documentation for a technical field by researching and analyzing information for a particular audience. Technical writers are Subject Matter Experts (SMEs) in communicating clear and effective messages. When can I use all caps?Unless you are using an acronym, never use all caps when you type. When you use all caps, you create difficult to read documents. Readers recognize words based on their shape created by the form of their lower-case letters. When you use all caps, you eliminate the word's shape that helps readers easily recognize the word. So, to help your reader read your document easily, do not use all caps.If you want to emphasize a word, use either an italicized or bolded font.Can I use an acronym at the beginning of a sentence?Yes. However, if you are using the acronym for the first time in the document, include the words the acronym represents next to the acronym so your readers understand what words it represents. The next time you use the acronym in that section, use only the acronym. For example:The Continuing Equipment Reliability Improvement (CERI) will interface with the following processes. CERI processes will follow on critical system, structures, and components.To view the list of Luminant's acronyms, refer to FFA-REF-0001, Definitions and Acronyms Glossary.When should I use e.g. and i.e.?Use e.g. when you want to say "for example"; use i.e. when you want to say "in other words." Always use a comma after both. Look at the examples below.e.g.Use the Equipment for Handling Fuel Chart to track fuel flow elements (e.g., hoods, chutes, skirts).i.e.Implement the procedures consistently (i.e., throughout each plant).When do I use numbers and bullets to present items on a list?Use numbers when the list needs to convey a sequential order or hierarchy, like steps in a procedure. Use bullets when the items in the list do not imply a sequential order or hierarchy.How do I use a comma with the last item in a series?When you use commas to separate items in a series, use a comma before the last item. When you include a comma before the last item in a series, you eliminate ambiguity from your writing. For example,CERI processes will follow on critical system, structures, and components.RecordsWhen completed, the following forms, reports, or other document generated in response to this procedure should be filed accordingly.<Type the document name, description, and location it should be filed.><Use the Bulleted List style.><Type the document name, description, and location it should be filed.>AttachmentsThe following attachments are appended to this procedure:<Using the format below, label the attachments appended to the procedure, which may includedata sheetsformscomputation sheetsfigures/illustrationsinformation tablesinstruction subsets, reference from the main body of the proceduredata packagesany information that is supplemental to the procedure. Use the Bulleted List style.<Remember that attachments support information in the body of the document. Do not use attachments as placeholders for information irrelevant to the purpose of your document. Also, do not store stand-alone documents in attachments.><Ensure the letters (A, B, C) for the attachments listed below correspond with the letters in the titles of the actual attachments.>Attachment A<Use the Normal style and then the Bold style.><Type title>Attachment B<Type title>Attachment C<Type title> ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download