The ASME Codes & Standards Writing Guide

purpose/audience

Before writing a code or standard, it is helpful to define the purpose of the document. What is the publication intended to convey and to what extent? How are the readers expected to use the code or standard, and what actions do they need to take with regard to the document? What information and emphasis will enable the reader to take the recommended action? Once these issues are considered, a scope should be written for the document. The scope should clearly define what information the code or standard covers. Typically, the scope is the first designated paragraph of the book.

It is important to keep the user of the code or standard in mind at all times. Who is going to reference it, who will take some action because of it, and what background or knowledge does the reader most likely have? How can the code or standard be arranged so that the reader will understand its meaning? If something is not clearly stated, it will not be clearly understood. Also, bear in mind that some international users may be reading English as a second language; therefore, clarity, conciseness, and proper grammar are important to the expression of the technical information.

reference Wg1-2
March 11, 2010