This paper presents the stages of preparation of the C4D software user manual. This software has been developed by PhDsoft and is intended to be used in connection with complex tasks such as the management of the integrity of the structures of offshore platforms, FPSOs and vessels, by providing repair and maintenance services such as sizing and placing of anodes, assessment of paint deterioration, among others. Oil companies tend to be huge in size and number of employees with different skills, psychological and behavior profiles. Considering that the software also serves as an interface with service providers, many other professionals were added, thereby greatly increasing this diversity. Therefore, meeting the needs of such heterogeneous expectations is the challenge faced by the author of the user manual. The purpose of the software manual is to facilitate the transfer of information and knowledge so as to develop the user's skills and competencies. Since the software is an engineering tool, it is not enough to present the directions and the steps of the software's specific tasks and procedures. It is necessary to provide the users with the technical principles used in the software functions. The manual must also be integrated to the company's strategy by adding value to the product so as to be perceived by the stakeholders as a strong aspect as regards the competitors, being also an effective instrument for establishing closer ties. This paper presents the experience of using a journalist to draft an essentially technical text, in an attempt to unite the attractiveness of the text to the accuracy necessary for its effective use, by following the best practices recommended for documentation and establishing metrics to check the efficacy of same, especially in accordance with norm IEE 1063 - Standard for Software User Documentation.
展开▼
