Mobile app version of vmapp.org
Login or Join
Hamm6457569

: Layout for technical documents I've being doing some research regarding how to present a good quality technical document (to be more specific, a PhD Thesis). It seems to me there is some consensus

@Hamm6457569

Posted in: #PageLayout

I've being doing some research regarding how to present a good quality technical document (to be more specific, a PhD Thesis).

It seems to me there is some consensus regarding the fonts (as described in What font types are good for a technical document? and Fonts for technical reports), which makes me very happy because I really like when standards are around.

So, since my thesis is in biomedical engineering, I've come to two conclusions: to use Times New Roman and to set the main font at 12pt (most of my readers are over 40 years old).

Now what I need to know as one of the most general characteristics is what the text block should be. I've read some Tschichold's guidelines, and it can be summarized like this:

textwidth=0.66666667paperwidth,%
inner=0.123paperwidth,% (inner margin)
textheight=0.666666667paperheight,%
bottom=0.22222222paperheight,%
headheight=1em,%


(Look here for a graphical description)

Now, it seems that is somewhat The Standard (although yesterday I was in a bookstore and I didn't see any book following Tschichold's scheme) for writing books, but is it OK to assume this should be the layout for a technical document? If not, what other set of rules can I follow?

10.02% popularity Vote Up Vote Down


Login to follow query

More posts by @Hamm6457569

2 Comments

Sorted by latest first Latest Oldest Best

 

@Megan533

The layout of a technical document depends on the document.

If you have a lot of pages with less tables, images, ... but a lot of text you should choose a font which is good for mass text. In my eyes it should be a font with serifes and ligatures (fi, ff, ffl, ...) for a better and easier reading. I would never choose Times New Roman, because this font is too small (used to print a newspaper, so narrow letters, no mass text). Better is Latin Modern or Libertine.

If you have only a few pages it could be better to use a font without serifes. But in my eyes this ends if you have more than three pages ... For poster it is better to use sans seriefe fonts ...

To get a proper european layout use with LaTeX KOMA-Script, for example class scrbook, giving you a perfect type setting area (simular to that Tschichold told) on A4 paper. Choose the fontsize for your mass text as you like: 10 pt, 11 pt (standard in KOMA-Script) or 12 pt. You can change the width of the margins with the option DIV for your used document class. The font size of title and headings depends on the font size of your mass text and is well choosed with KOMA-Script ...

On many universities you will get short papers how you have to write a thesis. Theese papers are usually made by people knowing nothing about a good typographie and so using old "rules" developed for the using of the old fashioned type writer maschines (German: Schreibmaschinen). Show your professor a well build document with LaTeX (not using the old rules) and he will accept it ...

Conclusion: a thesis with 60 pages is more like a book (with a lot of mass text) than a short technical document (how to use your mobile, car, ...) and you should use the "rules" developed by Mr. Gutenberg in 15xx, simular to the rules of Jan Tschichold.

10% popularity Vote Up Vote Down


 

@Cofer715

(Moved from comment)
look at other documents from your department. The reason you are having trouble identifying a standard, especially in the bookstore, is that there is no standard. Graphic Design is an art, not a science. We could cite studies about preferences etc, but they are really an attempt at bracketing an almost completely subjective subject in an objective manner. You will still be left with subjective leeway to get things done. If you need a rule, get some hardcopy and use a ruler. 12 pt seems reasonable. Margins and spacing are dictated by space, money and use requirements. (e.g grading/copyediting)



some pseudo-typical measurements for books:


.375-.675 (inches) margins
gutter margin larger by .75x
gutter margin smaller by .75x
bottom margin larger than top margin by 1.2x-1.5x
1.2x type size as line spacing (leading) for body text
header lines 1.2x-1.5x the type size of the type size one step lower in content hierarchy.
captions .75x-1x body text size, with line height 1x-1.2x caption text size
runaround for inset images: 1x body type size left/right; .5x body text size top/bottom




I'll add for a 3rd time: if your department has a style guide use it. It may be required. If you are submitting to a journal, they have guidelines. Use them.

In those cases, the decisions are being made for you.

10% popularity Vote Up Vote Down


Back to top | Use Dark Theme