HP TextEngineer Technical Writing Guide manual Verb Tenses, Active versus Passive Voice

Page 3

Company Writer's Guide

3.Make sure that your graphics clearly support information in the text. Have you chosen the most illustrative graphics in each section? Is there a difficult passage of text that you could elucidate with a figure?

Verb Tenses

As a general rule, use the present tense. For example, “our design includes” (not “will include” or “included”); “our Project Team is ready” (not “will be ready”). However, use future tense when describing project activities still to be performed. Also, use future tense in outline revisions when describing what completed sections will contain.

Use past tense when discussing completed project activities, observations from walkdowns, and the results of studies and tests already performed. “The controls analysis showed that…”

Active versus Passive Voice

Use active voice to raise impact. Examples include:

Passive: Procedures were initiated to reduce plant accidents.

Active: The company initiated procedures to reduce plant accidents.

Passive voice is acceptable, and is used often in customer documents, in a particular situation – when the object in the sentence must have emphasis over the subject.

Example: The Quality Plan must be followed by all subcontractors.

Additional Guidance

1.Avoid pathetic fallacy, that is, giving inanimate objects actions or responsibilities. Examples include:

•The Management Plan ensures . . . (a plan cannot ensure)

•The program is enjoying success . . . (a program cannot enjoy)

•The site must consider . . . (a site cannot consider)

2.The word “comprise” means to include or to be made up of. A large entity cannot “be comprised of” smaller things. It comprises them.

[For Illustration Only]

1-3

Page 2 Page 4
Image 3
Page 2 Page 4
Contents Great Content, Economically Delivered Section Style GuideWriting Style Approach 1. Examples of Wordiness Verbose-ese Equivalent Verb Tenses Active versus Passive VoiceAdditional Guidance ABBREVIATIONS, ACRONYMS, TRADEMARKS, and Symbols For Illustration Only Capitalization PunctuationNumerals and Units References For Illustration Only Editing Conventions GraphicsDeadman For Illustration Only VAC Appendix a Commonly Used Trademarks For Illustration Only Appendix B Abbreviations and Symbols Plurals of Abbreviations Letter Symbols for Units of Measurement Symbols for Units in General Use Symbols for Units in General Use Cont’d Symbols for Units in General Use Cont’d Symbols for Units in General Use Cont’d Symbols for Units in General Use Cont’d Symbols for Units in General Use Cont’d Called degree kelvin and assigned it the symbol K Symbols for Units in General Use Cont’d Symbols for Units in General Use Cont’d Symbols for Units in General Use Cont’d Symbols for Units in General Use Cont’d Symbols for Units in General Use Cont’d Symbols for Units in General Use Cont’d Symbols for Units in General Use Cont’d

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