For AI agents: a documentation index is available at https://idratherbewriting.com/llms.txt. Markdown versions of all pages are available by appending .md to any page URL.

Search results

When can I say "janky" in my on-screen text?

by Tom Johnson on Jul 18, 2008
categories: technical-writing

In the on-screen text in WordPress, on the Write > Page screen, I ran across the following help text.

When you can use the word Janky in your documentation?

Just yesterday my colleague Ben was asking how I felt about the use of contractions in help. Contractions? We've moved far beyond contractions. We're now using terms like janky.

How I would love to publicly insult the applications I document! E.g., Hey, we know this feature is kludgey, but we couldn't find an easy fix. Hang on -- the next release will get better.

Sponsored

About Tom Johnson

Tom Johnson

I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, agent skills, tech comm careers, and more. Check out my AI courses for more on the latest in AI and tech comm. If you're looking for info about documenting APIs, see my API documentation course.

If you're a technical writer and want to keep on top of the latest trends in tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me.

Finally, I want to note a couple of things. I usually write the first drafts of my posts myself and then use AI to improve accuracy, clarity, and detail in places, so my writing is a mix of human and AI. (Hopefully that's not too off-putting.) Also, the opinions I express on my blog are my own perspectives, not those of my employer.