DocumentCode
1520029
Title
Designing and writing operating manuals
Author
Lopinto, Lidia
Author_Institution
Software Exchange newsletter, 41 Travers Avenue, Yonkers, NY 10705
Issue
1
fYear
1984
fDate
3/1/1984 12:00:00 AM
Firstpage
29
Lastpage
31
Abstract
A manual should communicate the design engineers´ intentions for the operation of a process. To do this, it must be accurate, detailed, and logical, and it must be completed in time for the startup. Steps in preparation are structuring the manual; gathering and organizing information; making an outline; writing a draft; checking for technical accuracy; reviewing for consistency, style, and format; cross referencing and making an index; and distributing and accumulating updates and corrections.
Keywords
Accuracy; Indexes; Maintenance engineering; Manuals; Personnel; Systematics; Writing;
fLanguage
English
Journal_Title
Professional Communication, IEEE Transactions on
Publisher
ieee
ISSN
0361-1434
Type
jour
DOI
10.1109/TPC.1984.6448766
Filename
6448766
Link To Document