Kenneth Ormandy

Write a treedme

Published over 2 years ago • 2 min read

I finally put away the holiday decorations over the weekend. When I went to pack up the artificial tree, I was again pleasantly surprised to find this diagram I’d left for myself:

Years ago, the first time I had to re-pack it, I found it difficult to get it back properly into the original cardboard box. After struggling with it for a while, I eventually sorted out the arrangement. Then, I drew myself the diagram for when I inevitably encountered the same issue again.

In our typographic work, not all little annoyances are guaranteed to come up again, and not all can be solved by quickly documenting a key process or reason behind a decision—but a lot can.

While it’s expected that open source software projects will require a README—a text file with at least a little documentation on how to run or make use of the project—I still find myself surprised when this isn’t the case with private internal projects and font source files.

For some projects, you might think that, “I won’t need to come back to this.” In practice, this is difficult to predict. Maybe a single small change you need to make, turns out to not be so small as you have to understand where your files were left as well.

If a few notes on a key decision or where the project was left might be useful later, I think it’s a worthwhile tradeoff to invest in a little documentation now, while the ideas are fresh. Even if you truly never go back to this project, the habit tends to pay off on other occasions.

Another reason might be that, “no one will need to use this other than me.” Perhaps that means your entire company is just you, or simply that the majority of the time, you are solely responsible for a particular set of font source files.

Even still, there is at least one other colleague you are going to have to contend with at some point: you, from the past.

I know decisions that I’ve made that are crystal clear to me now, turned out not to be later, when I had to revisit my own source files. I’m reminded of this observation from Philippe Creux via Godfrey Chan via Kerri Miller:

Finally, a complete and concise definition of “Legacy Code” by Godfrey Chan: code that you didn’t write this morning.

Regardless of the version control or backup system you are using, all font source files should have is a README or equivalent: a text file that anyone working on the project can open, and get some kind of introduction to working with the files, or what state they’ve been left in.

A small diagram, or a few sentences explaining a key decision, might save you quite a bit of time and frustration. Even if, especially if, you only have open those files once a year or less.

Until next time,

Kenneth Ormandy

Read more from Kenneth Ormandy

The word random took on a new meaning in the 2000s. Everyone I knew labelled things as random. Almost as often, my dad pointed out that what was being called “random," was not random at all. It was just slightly unexpected. As Paul Hiebert wrote in 2011 for The Awl, the dictionary definition suggests something random is: without pattern or objective; it’s perfectly unbiased. To judge by the pop-culture usages cited above, however, the word has shifted away from its traditional usage, and now...

over 2 years ago • 1 min read

You probably already know instinctively your type foundry site doesn’t need reviews. Likewise, if you are deciding between fonts on another foundry’s site, it’s not something you expect to see. Baymard Institute investigated this for Direct to Consumer (DTC) sites, as part of their ongoing user experience research. I think these tests are often a decent approximation for type foundry sites (albeit without a digital download focus). The outcomes suggests that DTC site don’t benefit from having...

over 2 years ago • 1 min read

Type foundry websites can’t follow the recommendations prescribed for all websites. Sometimes, a foundry or type specimen site will need to break “best practices,” or even do the exact opposite. For example, the site might: Load many, many, fonts A fairly obvious one. The typical recommendation is to limit the number of fonts a site uses, to improve the page load time and size. A foundry will be loading many fonts, and more as time goes on. Wait indefinitely for fonts to load There are many...

over 2 years ago • 1 min read
Share this post