DI-QCIC-80922A

Special Acceptance Inspection Equipment (SAIE) Operating Manual

The SAIE Operating Manual DID specifies procedures for setting up and operating a specific item of Special Acceptance Inspection Equipment in accordance with the quality assurance provisions for the item under test.

Approval DateAugust 1, 2019

AMSC Number10058

Preparing ActivityMI

Project NumberQCIC-2019-001

OPR—

DTIC ApplicableNo

GIDEP ApplicableNo

Limitation—

Applicable Forms—

Approval Limitation—

Form Version—

DID Formatfree_text

963C CompliantYes

DISTRIBUTION STATEMENT A: Approved for public release; distribution is unlimited.

Supersedes

—

Description & Purpose

—

Application & Interrelationship

—

Use & Relationship

The SAIE Operating Manual provides detail procedures for setting up and operating a specific item of SAIE in accordance with (IAW) the quality assurance provisions for the item under test.

This Data Item Description (DID) contains the format, content, and intended use information for the data deliverable resulting from the work task described in the solicitation.

This DID is applied for acquisition of operating manuals for SAIE.

Preparation Instructions

1Reference documents.The applicable issue of the documents cited herein, including their approval dates and dates of any applicable amendments, notices, and revisions, shall be as specified in the contract.

2General.The SAIE Operating Manual shall delineate all the installation, operation, calibration, and maintenance aspects of the SAIE.

3Format and content.The format and content requirements of the SAIE Manual shall be IAW the following:

3.1Credits.The names of individuals or groups connected in any way with the preparation of the manual shall not appear in the manual nor may manuals be used to publicize any individual or group.

3.2Advertising.The SAIE Operating Manual shall not contain any advertising matter. Manufacturers' names shall not be used except where absolutely necessary to clarify installation, operation, and maintenance procedures. Manufacturers' names shown on equipment nameplates are permitted provided the nameplate appears in an illustration in the manual.

3.3Paper.

3.3.1Review manuscript.Review manuscript shall be on white paper (8X 10 1/2 inches or 8 1/2X 11 inches).

3.3.2Final manuscript.Final manuscript (camera ready) shall be on 20 pound weight bond paper (8X 10 1/2 inches or 8 1/2 X 11 inches).

3.4Covers.Front and back covers shall be prepared from paper of heavier stock than the text. Reproduction may be by any suitable method which will result in a clear copy. The final camera ready cover shall contain the manual number, approval date, supersession data and title of manual.

3.5Typing.The following are some general rules for typing manuscripts:

3.5.1Spacing.

3.5.1.1Review manuscript.Type the manuscript double spaced on one side of the paper only. The pages shall be of uniform size. Use black ribbon.

3.5.1.2Final manuscript.Type the manuscript single spaced on one side of the paper only. The pages shall be of uniform size. Use black ribbon.

3.5.2Spacing limits for page typing.When typing pages of manuscript, the manual number and the body of the text shall be enclosed in an imaginary frame 6 1/2 inches wide by approximately 9 inches long. The page number shall be centered at the bottom of the page approximately 3/8 inch below the last line of the page. (In no case shall any line of the type extend beyond these limits.)

3.5.3Page numbering.Number pages with Arabic numerals. Number the title page and content pages consecutively with lower case Roman numerals.

3.6Notes.Use notes throughout the text only when necessary to emphasize an operating procedure, condition, or the like.

3.7Cautions.Use cautions to call attention to an operating procedure, practice, or the like which, is not strictly observed, may result in damage to the equipment.

3.8Warnings.Use warnings to bring to the attention an operating procedure, practice, or the like which, if not strictly observed, may result in personal injury or loss of life.

3.9Table numbering and titling.Provide numbers and titles for all tables. Number tables consecutively throughout the manuscript. Double space between entries in the body of the table. When a single entry carries over to additional typed lines, single space the carry-over and indent two spaces.

3.10Division of text.Divide the manuscript into sections, paragraphs and subparagraphs, as necessary, provided no fewer than two of any subdivision are used. Use simple organization with as few subparagraph as possible.

3.11Subparagraph headings.Number subparagraphs with Arabic numerals and small letters (as applicable). If subparagraphs, identified by letters, require identification beyond the letter z, continue with aa --- bb --- cc and so forth.

3.12Appendix headings.Number appendices consecutively with upper case Roman numerals.

3.13Publication references.

3.13.1Use references to other publications to avoid repeating large volumes of information contained therein.Do this, however, only when the publications preferred to are available to the intended reader, otherwise, include the essential data in the text. However, it is preferable to repeat a small amount of information from another manual rather than to make reference to it.

3.13.2Do not refer to temporary publications such as circulars and letters or to publications of limited distribution.

3.14General Style.

3.14.1Use a simple, forceful style.Present information clearly, concisely and coherently in the order in which the reader needs it. Keep the general vocabulary of the text as simple and direct as possible.

3.14.2Do not use specialized vocabulary.Use commonly understood words instead of uncommon words likely to confuse the reader. Select words to make each thought clear, precise and understandable at all times.

3.14.3Be explicit.For example, when telling an operator to do something, also tell him how, when and why. Avoid indefinite words such as "excessive", "nearly" and "approximately" when referring to quantities that can be measured.

3.14.4Make a positive statement when giving instructions.Do not leave any doubt nor give the reader a choice if it is not so intended.

3.15Nomenclature.Be consistent in the use of nomenclature throughout the manual. Use approved nomenclature the first time that an item is mentioned. Shortened nomenclature may be used in later references but no change in terminology shall be made.

3.16General illustration requirements.

3.16.1Use illustrations to clarify text, call attention to details, identify component parts and identify electrical circuits and flows of air, water, steam and the like.Do not use illustrations which have no specific instructional purpose. Prepare final illustrations so that a minimum of work by cameramen or plate makers is required. Submit final illustrations with the final manuscript that are mounted and ready for the camera. The quality requirements for each type of illustration are as follows: Each final illustration shall consist of a photograph, mounted on a board with tissue and paper protective flaps. The illustration shall have crop marks and sizing. Callouts may be mounted on a transparent overlay or on the illustration and shall be firmly affixed. All numbers and letters on the illustration must be legible when reproduced in the manual.

3.16.2Wiring diagrams.Prepare wiring diagrams when the interconnection and not the shape of the various components or elements is important. Wiring diagrams depict the way in which the components or elements are connected, but usually make no attempt to portray the appearance of the components. Use nomenclature on the wiring diagram that is consistent with that used in text. Separate parallel lines in writing diagrams so that they are no less than one-eights inch part when printed. Use the symbols indicated in the latest revision of IEEE Standard (Std) 315, Graphic Symbols for Electrical and Electronics Diagrams.

3.16.3Flow diagrams.Prepare flow diagrams to show the direction of flow of fluids or gases between components using symbols or outlines for the components. All symbols must be identified. Use the symbols indicated in the latest revision of ASTM-F1000, Standard Practice for Piping System Drawing Symbols and ASTM F856, Standard Practice for Mechanical Symbols, Shipboard-Heating, Ventilation, and Air Conditioning (HVAC).

3.16.4Electrical schematics.Prepare an electrical schematic to show symbolically the functional relationship of the various electrical and electronic elements of the equipment. Separate parallel lines on the schematic so that they are no less than one-eights inch apart when printed. Use symbols indicated in the latest revision of IEEE Std 91, IEEE Std Symbols for Logic Functions; IEEE Std 315, Graphic Symbols for Electrical and Electronics Diagrams; and ASME Y14.44, Reference Designations for Electrical and Electronics Parts and Equipment.

3.17Illustration location of text.Insert the illustration in the manuscript following the page where it is first referenced. When two illustrations are referenced, insert them in chronological order following the page where they are first referenced.

3.18Cutlines and legends for illustrations.The cutlines and legends shall be typed on a separate sheet of white bond paper as they are to appear on the illustration and of the same style type and type size that is used to prepare the text. Include on the bond paper the page numbers of the illustrations and the manual identifying symbol without the revision designation. Type the cutline and legends of each illustration twice; each page number twice; and the manual identification symbol once for each illustration. Space on bond paper to allow printer to photograph, cut out and position the same on the illustrations.

3.19References.

3.19.1Use authorized abbreviations and symbols on illustrations in the text which are listed in the latest issue of each of the following publications:

3.19.1.1ASME Y14.38, Abbreviations and Acronyms for Use on Drawings and Related Documents

3.19.1.2ASTM F1000, Standard Practice for Piping System Drawing Symbols

3.19.1.3ASTM F856, Standard Practice for Mechanical Symbols, Shipboard-Heating, Ventilation, and Air Conditioning (HVAC)

3.19.1.4AMSE Y14.24, Types and Applications of Engineering Drawings

3.19.1.5IEEE Std 315, Graphic Symbols for Electrical and Electronics Diagrams

3.19.1.6IEEE Std 91, IEEE Std Symbols for Logic Functions

3.19.1.7ASME Y14.44, Reference Designations for Electrical and Electronics Parts and Equipment

3.19.1.8General Printing Office (GPO) Style Manual.

3.19.2The GPO Style Manual shall also be used as the standard for compound words, use of numerals, and capitalization.

3.20Human figure.Do not use the human figure in Inspection Aids Instruction Manuals.

3.21Color.Do not use color in illustrations unless specified in the contract.

3.22Illustration negatives.Negatives shall be unscreened on 8 X 10 inch or larger nonflammable film. Place each negative in a separate open-end manila envelope. Identify the contents of the contents of the envelope with the figure number and publication number in the upper left corner of the envelope.

3.23Identification.Manuals shall be identified by number and the approval date. The number shall be provided by the ordering agency. The symbol and date shall appear at the top right side of the cover sheet, title page, and page 1 of the manual. The symbol without the dates shall appear on all other pages (top left on even numbered pages and top right on odd numbered pages).

3.24Revisions and supersessions.Revisions to a manual shall be indicated by capital Gothic letter following the symbol. The latest approval date shall appear under the symbol. The cover sheet, title page, and page 1 shall include a note indicating that the previous manual has been superseded. The supersession shall not be placed under the approval date, separate from the date by a ruled line. The supersession date shall list each manual superseded, together with its date.

3.25Format.The contents of the manual shall be governed by its purpose. In general; however, the manual shall be developed IAW the following listing:

3.25.1Cover page.The title, number, revision, symbol, date of issue, supersession date (when applicable) and the name of the ordering agency shall appear on the cover page.

3.25.2Title page.The title, number, revision, symbol, date of issue, supersession date (when applicable) and source of copies shall appear on the title page.

3.25.3Contents page.The single word CONTENTS in capital letters and underlined shall appear at the top center of the contents page. The contents shall contain the eight or nine sections, first subparagraph heading (under applicable sections) and list of Appendices.

3.25.4Caption for page one.The caption for page one shall be centered at the top of the page. It shall consist of the name of the ordering agency and the title of the manual.

3.25.5Text.The text of the manual shall contain eight or nine numbered sections as outlined below: 1. SCOPE 2. THEORY OF OPERATION 3. APPLICABLE DOCUMENTS 4. UTILITIES AND FACILITIES 5. REAGENTS AND MATERIALS (When applicable) 6. APPARATUS 7. INSTALLATION AND OPERATIONS 8. SAFETY 9. MAINTENANCE Additional subheadings shall be added under the numbered sections above as applicable to the instruction manual being prepared. NOTE: When the REAGENTS AND MATERIALS sections is not applicable, the subsequent sections shall be renumbered, APPARATUS becoming section 5, etc.

3.25.6Appendices.Each manual shall contain three appendices. Appendix I shall consist of an index of figures, tables, charts, and the like which appear in the body of the text; Appendix II, an index of major parts of the equipment; and Appendix III, the repair parts.

3.26Definition of manual sections.

3.26.1Section 1. SCOPE.A clear, concise description of the extent or range of technical content which shall be used as the principal statement of the scope. A second statement shall define the purpose of the tester.

3.26.2Section 2. THEORY OF OPERATION.This section outlines the theory and sequence of operation.

3.26.3Section 3. APPLICABLE DOCUMENTS.All specifications, standards, drawings, publications, and the like which form a part of the manual shall be listed under this section. Except for Government publications, the name and identification symbol of the specific issue of the document referenced shall be used. For Government documents the basic name and symbol (without revision identifications shall be used. Where changes in title have occurred in referenced documents, the title current at the time of the development of or revisions to the manual shall be used. Referenced documents shall be grouped under appropriate headings. Documents issued by the Government shall be listed under "Government Documents". Documents published commercially shall be listed under "Other Publications".

3.26.4Section 4. UTILITIES AND FACILITIES.List all the utilities and facilities that are required to install, operate and maintain the test equipment.

3.26.5Section 5. REAGENTS AND MATERIALS.This sections (when applicable) shall contain a list of reagents and materials peculiar to the equipment. Included in this listing shall be information which may be helpful when procuring reagents or other material such as type, class, grade, composition or other classifications. The use of federal or military specifications and standards is mandatory provided the reagent or material is suitable for the intended use.

3.26.6Section 6. APPARATUS.This section covers the following:

3.26.6.1Description of components.The major parts of the test equipment are described in sufficient detail to establish the location, physical characteristics and function in relation to the equipment and to associated components. Major parts are identified by index numbers (callouts) and are tabulated in Appendix II.

3.26.6.2Systems operation.Systems operation is the method in which the components of the test equipment are caused to act independently or in combination to produce a desired result. The action may be caused by any one, or a combination of manual and conventional power sources such as pneumatics, electricity, etc. Diagrams and schematics shall be used to depict the travel of each type of power through the systems of the equipment.

3.26.6.3Sensitivity.Sensitivity with respect to this test equipment is the minimum measuring, detecting, or indicating capability of the equipment. The range of sensitivity is the measuring detecting or indicating capability of the equipment from the minimum to the maximum, within established tolerances.

3.26.6.4Production capability.The production capability is the number of items that the equipment is capable of testing in one hour on the production line basis. When the production capability is applicable to more than one type test item, the hourly production rate for each item shall be stated.

3.26.7Section 7. Installation and Operation.This section contains instructions for the installation, calibration, adjustment, operation and shutdown procedures. Information and instructions shall be compiled under the application headings:

3.26.7.1Installation.Include instructions and information such as mounting the tester, connecting air, water, steam, electrical power and the like. Include only the information required to initially install the equipment.

3.26.7.2Calibration.This portion of Section 7 provides the step-by-step calibration procedure required to ensure that the tester is maintained within prescribed accuracy limits, which in turn will ensure that supplies and services presented to the Government for acceptance are in conformance with the prescribed technical requirements. The definition of the word "calibration" as intended for use herein is, "The comparison of a measuring standard or instrument to detect, correlate, report, or eliminate by adjustment, any variation in the accuracy of the item being compared". The following considerations are applicable when establishing calibration requirements:

3.26.7.2.1What items will require calibration?

3.26.7.2.2What range of accuracy is required?

3.26.7.2.3The method or alternate method to control the accuracy.

3.26.7.2.4The calibration interval.

3.26.7.3Adjustment.After the tester has been installed and all applicable components calibrated, adjustments may or may not be necessary prior to actual operation of the tester. Adjustments could vary from tightening screws to opening and closing valves. In some instances, adjustment and calibration may be so closely related that they cannot be separated. Should this condition occur, combine the two and title the same "Calibration and Adjustment".

3.26.7.4Operation.When preparing this portion of Section 7, it is most important to detail, in operational sequence, the step-by-step procedures that the operator must follow. Simplicity of presentation is most important. Where an explanation of a phase of operation can be of value to the operator, add the same as a note under that particular phase. Keep sentence structure short and elementary. Refrain from using terms that are peculiar to technicians and engineers. If such terms must be used, follow the operational step with an explanation of the term. This again would appear as a note following the operational step.

3.26.7.5Shutdown.In this portion of Section 7, describe the procedures for daily shutdown and for complete shutdown of the equipment.

3.26.8Section 8. Safety.This section describes the hazards involved in using the tester. The following statement shall be included: The using organization shall prepare a standard operating procedure (SOP) including all precautions necessary for the safety of using personnel.

3.26.9Section 9. Maintenance.This section covers the maintenance procedures that are necessary to keep equipment in good operating condition. The equipment may be such that it requires daily and long range maintenance. Troubleshooting shall also appear in this section.

References

—

Schema v3.0Community-maintained · Verify against ASSIST

Community-maintained — not an official government database.
Verify against ASSIST·GitHub·About·Disclaimer