Update to Time of Day Trigger wiki page

Wiki
1

I've made a couple of minor changes to the Time of Day Trigger page that I want to review with the other Wiki editors.

Title Format Change

The first, minor, is the title was formatted as

===== Time of Day Trigger =====

which came out as an H2 title in the rendering, so I changed it to

====== Time of Day Trigger ======

which renders as H1, for consistency with other pages.

Title Format Sanity Check

So the "sanity check" quesition is: Has anyone been using that font difference for any kind of subtle categorization of the pages, or was it simpy a true typo?

AM/PM Feature Included

Second, the original version of the page described the trigger as

My clock is set for 24hour time, so there is no am/pm indicator.

Since there is now an AM/PM indicator, I changed that to

Older versions of Keyboard Maestro use 24-hour time with no AM/PM indicator. More recent versions use a 12-hour clock with an AM/PM field.

I would have mentioned the exact version it changed in, but searching through the Announcement section I was not able to find a reference in the various version release notes describing that particular change. Does anyone reading this know when it happened?

AM/PM Feature Santity Check

Another sanity check question: This feature is not dependent on a system setting like whether the system time is shown in 24- or 12-hour, is it?

First Person?

And as an asside, stylistically it's pretty rare for a software manual to refer to the author in the first person ("My clock"), but it's also more on the "warm and personal" side. I took it out because the feature edit no longer required an ideosyncratic explanation (and because I could not speak for Peter). Any comments?

1 Like
2

User manuals—software or otherwise—should avoid referring to the author or the user as much as possible. The focus should only be on providing concise, explicit instructions. From another field, it's like how recipes are written:

  1. Place two tablespoons of oil in pan and heat on high for one minute.
  2. Add diced onions and stir to coat.

Well-written recipes don't say,

  1. Grab your sauté pan, put it on the burner, then you can add two tablespoons of oil.
  2. Heat that on high for a minute and then you add the onions you diced.

Looking at manuals provided by manufacturers of all sorts show this is a well-followed practice known to most likely achieve the desired outcome. Lest there be any doubt about my position, this does not apply to feature descriptions, just the instructions necessary for those features. So writing something like,

This feature set lets you OCR text, make coffee, build your business reports, and floss your teeth!

is fine. But references to the user or author should be avoided when explaining how to use those features.

3

They should be consistent. Sadly, because this is a wiki and not any kind of proper database content management system, keeping any kind of consistency is very hard.

There isn't even a proper template page that would have the definitive format so the best that can generally be done is look at a bunch of pages at random to see what is used most often.

This is system dependent. Mine does not show the AM/PM, and shows it in 24 hour mode, because that is what my system is set to.

I'm not sure what the original page said, or whether there was ever a change to this. IOt's probably always been system dependent.

Yes it is.

Without looking at the original text, I'm not sure, but generally, no, the wiki should not be referencing "My" anywhere.

OK, I went and looked at the original page, I believe the statement was simply explaining the image shown’s lack of an AM/PM indicator. It was written in 2008 - almost two decades ago and has remained unchanged since then.

The statement should have been written in the impersonal and referenced the image, something more like "The image does not show an AM/PM indicator only because the system on which the image was captured was configured to 24 hour clock". Something like that anyway.

4

Done.

1 Like