Category > Uncategorized

Writing for Business and Technical Audiences

» 19 November 2022 » In Uncategorized » Comments Off on Writing for Business and Technical Audiences

Something a little different here.

While I was away, I did plenty of writing, but none of it was for public consumption. A major part of my job at large technology companies has been reading, writing, and editing documents explaining various issues and what can be done to address them. I think it’s a more important skill than people generally realize, as it may be the one way to reach someone in a different time zone, or who couldn’t make a meeting, or who you will never speak with in person. Effectively written documents also have a way of hanging around, so investing in them can pay back over the long term.

I’ve also learned through experience that there is value in good writing in ways that aren’t always obvious. A well-articulated error message in a log file or api response can save an engineer significant time, for example.

Over the years I’ve gathered a set of guidelines that have worked for me. I’ve made it a habit of sharing this type of stuff internally at the companies I work at, but none of this is specific to any company, so I’d like to share publicly this time.

This list benefited from feedback and revisions provided by professional colleagues of mine. I won’t name them here, but thank you to those of you who read drafts of this and offered feedback.

Know Your Audience

Know who you want to reach, what you need them to know, what context they have/don’t have, and what you want them to do with the information you will convey. Make it as easy as possible for them to get what you need from your communication. Be clear if there is a call to action or follow up you need from them, and by when.

Incidentally, probably the single biggest factor in the previous success of NPB Tracker was that I knew who I wanted to reach and inform.

Headings

  • Titles: Make your doc title meaningful and discoverable in search.
  • Email Subjects: Make the subject scannable so the reader knows whether they need to read and if there’s an action that they need to take.
  • Subheadings: use them to make your long document or email more easily scannable.
    • The subheading of a paragraph should summarize what the paragraph is about.
  • Write the names of the authors, contributors, and reviewers at the top of the document. Most templates have this. Do it for everything.
  • Include the date the document was started. I prefer the format YYYY-MM-DD because it is the international standard, and avoids ambiguity between the American and British formats. Spell out the month for extra clarity.

Introductions

  • If there is a specific proposal in the document, put it right at the top. This gives the audience the option to decide whether to read the whole document or not.
    • Example: “This document proposes developing a Twitter client for the Atari 2600 platform, funded with four SWE headcount and a target release date of June 1983.”
  • Set a clear expectation for the audience upfront. Sometimes I write a “How to read this document” section at the top to make this obvious.
    • Example: “this is a collection of notes on an early stage product, no major decisions are being proposed yet.”
  • As a rule of thumb, I normally write my introductions last, after I have written the rest of the document.

Content

This set of suggestions is primarily relevant to longer form documents, proposals, and emails.

  • Don’t make assumptions about what your audience knows. If assumptions are unavoidable, make it clear what the assumed knowledge is.
  • Define key terms that may be unfamiliar to the audience.
    • Example: “Atari 2600 is a video game console that was popular in America during the early 1980s”
  • Be as specific as possible.
    • Words such as many, almost, nearly, significantly, better, worse, etc imply different things to different people. Being specific takes away this ambiguity. 93% of bugs, increase of 7% performance, etc. The specifics also show that you are speaking from a place of knowledge instead of filling in content.
  • Follow the Amazon rules (source), particularly:
    • Replace adjectives with data
  • Avoid “weasel words” – words that are ambiguous or misleading. Examples, taken from Wikipedia, include:
    • “People are saying…” (Which people? How do they know?)
    • “It has been claimed that…” (By whom, where, when?)
    • “Critics claim…” (Which critics?)
    • “Questions have been raised…” (Implies a fatal flaw has been discovered)
  • Avoid inside jokes and pop cultural references in the core points of the document. These might increase engagement for some, but exclude others who aren’t in on the joke.
  • Read up on inclusive language and make sure you aren’t including outdated terms.
  • Put reference links in an appendix section.
  • Define acronyms, abbreviations and other key terms that reader may be unfamiliar with at the beginning of your document
  • Add visuals if possible – charts, graphs, architectural diagrams, etc.
  • Avoid condescending words (obviously, of course, clearly)

Editing

  • Edit your documents for clarity and correctness. Take a break between writing and editing.
  • Have a few trusted early draft reviewers, who can give you feedback before you share widely.
  • As a rule of thumb, I try to focus on removing unnecessary detail and content when I edit my writing, to amplify the most important points.
  • Remove redundancy. Are you saying the same thing 3 different ways?

Reading

  • Make time to read others’ documents.
  • Share interesting things you read with others.
  • Don’t be afraid to give positive feedback.

Continue reading...

What’s In The Works

» 30 October 2022 » In Uncategorized » Comments Off on What’s In The Works

One of my old habits as a writer was to make lists of the articles I planned to work on. I found that it kept me accountable to producing some level of work, even if what I finished wasn’t always what I started. Here’s what I have in mind for this iteration of NPB Tracker…

  • A look at the Yakult Swallows and the Orix Buffaloes, contestants of the last two Nippon Series.
  • How I would have rebuilt Yakult, basically a retrospective on what I said I’d do, but never did.
  • A look ahead at this upcoming NPB imports to MLB.
  • How baseball has changed for me, personally, over the years.
  • Muzak in Japan.
  • A review of the King Jim Pomera device.

In addition to the baseball content, it’s likely that I’ll work in some business and technology-related content into the site. I actually never stopped writing, but the majority of what I wrote was intended for business audiences, internal to whichever company I happened to be working for at the time. If some of that stuff is applicable to a general, public audience, it may show up here as well.

Continue reading...

Hello Again

» 21 October 2022 » In Uncategorized » 3 Comments

While I was away, someone else successfully rebuilt Yakult.

Continue reading...

Questions To Ask Startups

» 28 June 2017 » In Uncategorized » Comments Off on Questions To Ask Startups

This is something very different. I have had the itch to write again for a while now, but real life has kept me busy enough that I can’t devote enough time to baseball to come up with anything interesting to say about it. So I’d like to write a little bit about my work experience, in the hopes that someone out there may find it helpful in some way.

Some of my remaining dozen or so readers probably know that I’ve spent the bulk of my professional career working at startups in Silicon Valley. Most of my experience has been in middle management, specifically of engineering and technical teams, and along the way I’ve learned a lot about what to look for in a startup as an employer. On my most recent trip through the job market, I made it a priority to join a quality company, so I came up with a list of questions to ask startups to try to evaluate whether they might pan out.

I ultimately decided against joining a startup, but having a framework for what I was looking for and how I was evaluating it helped me engage in better, more mature discussions with prospective employers. Although I specifically had pre-profit, venture-backed companies in mind when I came up with these questions, many of them could apply to any business. Here’s hoping someone out there finds them useful.

PRODUCT AND CUSTOMERS
1. What does the startup exist to do?
2. Who are the users?
3. Who are the customers?
4. What do they like about the offering?
5. What needs to get better?
6. What can customers get here that they can’t get anywhere else?

CASH AND FINANCES
1. Who are the investors?
2. How much runway is available?
3. What is the goal of the next round? Is the emphasis to grow and raise, or reduce burn and break even?
4. How transparent are the company’s finances to leadership, and the employee base?

LEADERSHIP
1. What is the CEO’s background?
2. What is the founding team’s role?
3. What are the CEO’s values? What values are shared among the VP/C-level?
4. What is the existing technical and managerial leadership structure?
5. What is the depth of skill and investment in each functional area (engineering, sales, etc)?
6. How transparent is leadership with success metrics, and opportunities and threats to the company?

ORGANIZATION
1. How is the organization structured?
2. Who has the most influence over product and technical decisions?
3. How are key decisions made, socialized, and instituted?
4. How strong is the second layer of leadership?
5. Is any house cleaning needed?
6. Are there candidates for career growth?

PROCESS
1. How ‘mature’ is the product development process?
2. Are successes repeatable and are failures turned into actionable improvements?
3. Are metrics defined? How widely available are they to the staff?

MY ROLE
1. What areas are in the most immediate need of improvement?
2. What impact do you expect this role to have on the team, offerings, and company?

EQUITY
1. How many shares are outstanding?
2. What is the strike price of shares issued in the most recent round of funding?
3. What is the vesting period?

Continue reading...

Why Japanese Baseball?

» 06 June 2017 » In Uncategorized » 2 Comments

In the nine years since starting this site, I’ve done dozens of interviews and talked to perhaps hundreds of fans, readers, and other writers. The question I get more than any other, by a wide margin, is some variation of “why Japanese baseball?”

I’ve occasionally told the story of how I was introduced to Japanese baseball but I’m not sure I’ve ever answered the question of why it’s appealed to me so much. I’ll try to do that here.

The starting point for me was my interest in Japan. At age 11 I picked up a video game magazine that happened to have an article in Japan, and that was it.

The first thing that hooked me on Japanese baseball was the novelty of it. It was baseball, but it was new and different. The pitchers had funky deliveries and throw off-speed stuff, the batters had more character than their MLB counterparts, the uniforms were different, the fields were different, the fans were entertaining.

As time progressed and I learned more about NPB and baseball in Japan, my appreciation for it grew. It sounds cliched, but the relationship between the players and the fans is different in Japan. NPB players are, for the most part, a bit more down to earth than players in American sports leagues. Hang about the Yakult Swallows’ Jingu Stadium before a game and you’ll see uniformed players and coaches going about their work, going back and forth between the practice field and the stadium amongst the fans and vendors.

It isn’t just the Japanese players who are down to earth. Most of the foreign ball players are journeyman, who are exceptionally good players, but not quite great enough for MLB. Most of them come across as legitimately grateful for their chance at playing in Japan, and I’m always happy to see hardworking players get a shot at establishing themselves in Japan.

The fans, in turn, are a bit more uniform in their support for their favorite teams. Yes, there are fair weather fans and some players are more beloved than others, but at games, the cheering vigor of the fans doesn’t drop from batter one to batter nine. I’ve found Japanese fans to be incredibly welcoming as well. At my first Kitetsu Buffaloes game back in 2001, the salaryman sitting beside me made sure I knew every player on the field, and bought me balloons for the seventh inning stretch balloon launch. Some variation of this has happened at many of the games I’ve attended since.

I feel like this explanation, so far, does a disservice to the quality of play. I won’t pretend the quality of play in NPB is MLB-caliber, but it is certainly good, competitive baseball. The best players have proven to be successfull at the MLB level, and even the role players usually have some redeeming skill. I’ve enjoyed appreciating in players; one guy may have a great throwing arm, another may have great bat control, another may be a bunting specialist.

Most North American fans look at leagues in Asia as sources of talent for Major League Baseball, and that’s fine, but NPB and KBO are good baseball leagues worthy of appreciation for their own merit. I started NPB Tracker primarily to combat incorrect information about Japanese players bound for MLB, but also to increase overseas interest in Japanese baseball. Over the passed nine years, the quality of information on Japanese players has improved dramatically. But I can’t measure any real uptick interest in the league itself from overseas, which perhaps should be next goal.

tl;dr: Japanese baseball is good because:
1. it’s fun and different
2. the bond between the players and fans is deeper
3. it’s good baseball

Continue reading...

Farewell Wayne

» 20 April 2017 » In Uncategorized » Comments Off on Farewell Wayne

Last Wednesday, I got an email from my friend John Gibson that long-time Japan Times baseball columnist Wayne Graczyk had passed away. I didn’t know Wayne personally, but his passing saddened me. Wayne was one of my early guides to Japanese baseball, and his work made the league accessible to before I learned to speak and read Japanese.

I didn’t know it at the time, but I first heard Wayne’s voice in 1994. The MLB player’s strike had cancelled the World Series, and my local sports cable station showed the Japan Series, broadcast by the White Sox announcers and some guy who lived in Japan. That guy happened to be Wayne, and although I didn’t remember his name, I absorbed much of what he had to say. And so began my fascination with Japanese baseball.

Fast forward to 2001, when I was a youthful English teacher working at a Nova chain school somewhere near Osaka. Every time a Japan Times shows up in break room, I would immediately flip to the sports section and read Wayne’s Baseball Bullet-in column. Life in Japan was still new, and baseball was both comforting in it’s familiarity and fascinating in its differences. Wayne had a deep understanding of Japanese baseball, and I learned through his work, bit by bit, until I learned Japanese well enough to get by.

Fast forward again to 2008, when I started npbtracker.com. I was working on a blog post that was a collection of links, and I decided to call it “NPB Bullet Points,” as a nod to Wayne’s influence on my work. The name stuck and I wrote dozens, if not hundreds, more posts using that title.

I think that Wayne knew that Japanese baseball, like most things, could be enjoyed more thoroughly with a deeper understanding of it’s culture, nuances, and history. This was certainly reflected in his writing, and I’ve always tried to carry on the tradition in bringing Japanese baseball to new audiences.

I never met or exchanged emails with Wayne, but without his work, my development as a writer would have taken a different path. My condolences go out to his family, friends, and loved ones.


I never got to thank Wayne personally for his work. I’m lucky to have met my other early influences in Japanese baseball, Jim Allen and Michael Westbay, multiple times, and happily call them friends. But I’d like to show my appreciation to them once more, and say thank you. Without the work Jim, Michael, and Wayne have done to make Japanese baseball accessible to English-speaking audiences, there certainly would never have been an NPB Tracker.

Continue reading...

Japan Baseball Weekly Appearance & I’m Still Around

» 22 March 2015 » In Uncategorized » 3 Comments

This a post to announce that while this site is in stasis, I’m still around. And I have the podcast appearance to prove it:

Speaking of appearances, I never mentioned that I was on Japanese television last autumn. More on that later.

Continue reading...

Japan Baseball Weekly Podcast

» 14 April 2014 » In Uncategorized » 2 Comments

This weekend I had the pleasure of filling in for Jim Allen as a host of the Japan Baseball Weekly Podcast. You can download here, from the top of the list.

John Gibson and I had to contend with the head cold I’ve been suffering, time zone differences and flakey Skype performance, but we battled through and had a great discussion about Lastings Milledge and the Yakult Swallows, the juiced ball controversy du jour, and the state of the Pacific League. I hope you’ll enjoy listening to it.

Thanks John for having me on! I’m looking forward to taking part again!

Continue reading...

For Those of You Looking For the Data Site…

» 31 July 2013 » In Uncategorized » Comments Off on For Those of You Looking For the Data Site…

I had to take it offline because of a few bugs that were causing problems. I haven’t found the time to fix them yet, but it should return at some point, hopefully before too long.

Continue reading...

Yokohama DeNA to Work Out Three

» 03 February 2012 » In Uncategorized » 1 Comment

Looks like the Baystars are in the market for a corner infielder. The team has announced that it will have infielders Wes Bankston, Chris Nowak, and Oscar Salazar in camp on a tryout basis. Longtime third baseman Shuichi Murata departed for Yomiuri this offseason, and prospect Yoshitomo Tsutsugo has had a rough go at the hot corner on the farm team.

In other news that is only tangentially related, former BayStar Hiroki Sanada is headed to the US for tryouts. Yokohama granted Sanada his release after he failed to attract any posting bids.

Continue reading...

Tags: , , , , ,