logo_color

BD Tech Concepts llc

Technical Documents

Businesses and self-published authors greatly benefit from outsourcing document editing, design, and typesetting. Rather than wrestling with a word processor, have BD Tech Concepts LLC organize and format your work for you, using an advanced programmable document-typesetting system.

See how Technical Editing can improve your book in general grammar and spelling, and structural organization and cross-referencing.

Book & Monograph Design has a technical book design, formatted for tablet use. A properly formatted pdf file has advantages over the epub format when complicated math and diagrams are involved.

Classical Documents has samples of a more general nature. Technical book samples are below.

Book Design

See Book & Monograph Design for an example of a technical book edit and redesign, including text scan-to-pdf conversion and vector-diagram conversions.

gear_design-33.png

Figure 36: Gear-Tooth Forms

White Paper

See Sample load cells white paper for an example technical white paper.

load_cells-8

Figure 37: Load Cells — Creep Recovery

Front Panel Illustration and Call-Outs

Sample: CNC Control Box Setup — pdf

Call-outs are identifiers used to specify the specific user-interface elements being discussed in the text. In this example, each call-out is used to point to a piece of information in the display, is used again in a small table of descriptions of each element, and yet again in the accompanying text.

cnc_control_p3

Figure 38: Front-Panel Illustration and Call-Outs

Diagram Call-Outs and Installation Sequence

Sample: Automatic Door Closer Installation Manual — pdf

Diagram call-outs (“pins”) may refer to the same part in several views at the same time. As seen in the pdf document, these views are repeated in mirror-image to assist with left/right opening doors. Each installation is on its own set of pages, with the same instructions and callouts repeated again for each set. Repeating these instructions in mirror-image reduces confusion and helps to avoid improper installations.

autoclose-7

Figure 39: Connection Instructions — Automatic Door Closer

Operating Sequences and Inline Key/Display Icons

Sample: Fryer FC-1234 User’s Manual — pdf

Printing the key icons directly inline in the text helps the user to quickly locate the corresponding key on the unit. Likewise, visually replicating the led display in the text shows the user exactly what each message looks like.

fryer_manual-4

Figure 40: Display and Key Representations

Problems and Mathematics

“Thanks, it looks great! Very impressive conversion!”

Sample: “Slide Rule Guide” — pdf

By Mario G. Salvadori and Jerome H. Weiner, originally edited by Joseph L. Leon — Data-Guide, Inc. 1956. (Document in the public domain.)

Special typesetting is used to present example problems in an attractive format. A consistent structure is used to present each example math problem, how to mentally compute an approximate answer, then how to perform the operations necessary to arrive at the exact answer.

sliderule_after

Figure 41: Problem Example and Mathematics

Page Layout and Table

From Slide Rule Guide, by Mario G. Salvadori and Jerome H. Weiner, originally edited by Joseph L. Leon — Data-Guide, Inc. 1956. (Document in the public domain.)

sliderule_guide-34

Figure 42: Instruction Manual — Examples and Table

Linotype Manual

Sample: Linotype Manual — 3.4 M pdf

Re-typeset by BD Tech Concepts LLC with image enhancements, corrected figure numbering, and additional List-of-Figures and List-of-Tables.

linotype-01 linotype-08

linotype-31 linotype-44

In the public domain.

Figure 43: Book Design — Linotype Manual, by F. H. McCall