Company Writer's Guide

APPENDIX B

ABBREVIATIONS AND SYMBOLS

Abbreviations facilitate reading and minimize dull repetition of cumbersome names. Abbreviations should be used only when necessary and when their meanings are unquestionably clear. When in doubt, spell it out. In the text, capitalization will agree with the parent word. Rules of capitalization apply. The same abbreviation should be used for all tenses, possessive, singular, and plural. A sentence should never begin with an abbreviation except where the parent word(s) would result in an awkward construction.

The following pages contain basic rules to use when abbreviating, and a list of engineering unit abbreviations in their proper form.

1.Abbreviations should be spelled out in all possible circumstances. However, when abbreviations are necessary, use the following guidelines:

a.The trend is to omit periods from all abbreviations except where they have traditionally appeared (for example, U.S., Ph.D., Mr., Mrs.).

b.There should be no space after the internal periods within a traditional abbreviation (for example, a.m., U.S., i.e., etc.).

c.An abbreviation needs no period unless it can be confused with a word (e.g., in., a.m., no.,). One exception to this rule is a period usually is not necessary in tabular material.

2.The following common Latin abbreviations should appear as:

i.e., (that is)

e.g., (for example) et al., (and others) etc., (and so forth)

A comma should precede and follow the above abbreviations when used in the middle of a sentence.

3.“versus” should be spelled out, not “vs.”

[For Illustration Only]

B-1

Page 15 Page 17
Page 16
Image 16
HP TextEngineer Technical Writing Guide manual Appendix B Abbreviations and Symbols
Page 15 Page 17

TextEngineer Technical Writing Guide specifications

HP TextEngineer is an innovative technical writing tool designed to streamline the creation of documentation for software, hardware, and other technical subjects. Tailored for professionals who aim to produce high-quality content efficiently, the HP TextEngineer offers a variety of features and technologies that set it apart in the realm of technical writing.

One of the main features of HP TextEngineer is its intuitive user interface, which allows writers to focus on content creation rather than getting bogged down by complicated software navigation. The interface is designed to be user-friendly, providing easy access to the essential tools needed for drafting and editing technical documents. Users can easily insert images, tables, and diagrams, making it simple to present complex information in an understandable manner.

Another notable characteristic of HP TextEngineer is its collaboration capabilities. The tool supports real-time editing, enabling multiple writers to work on the same document simultaneously. This feature encourages teamwork and enhances productivity, particularly in environments where technical documentation is a collective effort. Additionally, the software includes version control, which keeps track of changes and allows users to revert to previous versions if necessary.

HP TextEngineer also leverages advanced technologies such as artificial intelligence and machine learning to assist writers. Intelligent suggestions for content improvement, grammar checks, and style recommendations help authors refine their work, resulting in clearer and more concise documentation. These technologies assist in automating repetitive tasks, allowing writers to focus on more critical aspects of their projects.

Another significant aspect of HP TextEngineer is its support for various output formats. Whether a company needs to produce PDFs, HTML documentation, or ePub files, HP TextEngineer can accommodate these requirements effortlessly. This flexibility ensures that technical documents can be distributed across multiple platforms while retaining their original formatting and integrity.

In addition to robust writing tools, HP TextEngineer incorporates templates tailored for specific industries and document types. This feature helps writers maintain consistency in style and layout, which is critical in professional documentation. By utilizing these templates, teams can create cohesive documents that align with organizational branding and standards.

In summary, HP TextEngineer emerges as a powerful tool in the technical writing domain, equipped with user-friendly features, collaboration capabilities, AI-driven assistance, diverse output options, and customizable templates. As technical writing increasingly becomes a vital component of successful project execution, tools like HP TextEngineer are essential for producing high-quality, precise documentation that meets the evolving needs of industries.
Top Page Image Contents