Showing posts with label useful. Show all posts
Showing posts with label useful. Show all posts

Saturday, October 23, 2021

Fixing a novice document design issue

When it comes to document design, it's an interest of mine and I'm passionate about it. I think of how useful the document is to the end user when I'm either creating or updating a document.

A few months ago, when I looked at a document that a fellow colleague was working on, she had repeated the service that she was documenting in the title of every page. I asked her why she did that. She told me that her team lead, the diva, told her to.

Ugh. That's poor document design. It's pretty clear that you're in a document talking about the service. Why have it as a prefix for the title of each page that you have? You're taking the user read the same prefix over and over. Is that practical or helpful? No.

Her argument was that it was a best practice from a previous solution that she worked on. Um, no. Your page titles needs to be meaningful, but not monotonous and redundant.

My manager sent her a request to fix this issue in multiple documents. 

I'm such an advocate for the end user. This person wants answers immediately when looking at a document. It's not happening with unnecessary fluff.

My colleague had brought up this issue, but the diva was adamant that she was right. The issue is that the diva doesn't come from a writing background and it shows here. Our colleague does. I do, too.

The other sad thing is that she has been a writer on our team for seven or eight years now. She hasn't caught on.

Friday, June 24, 2016

Being a helpful support person and wanting to be a good girl

My guy is like a sweet little boy sometimes. I just want to cuddle and kiss him, but he is still away on business.

He called me at nearly 05:00 his time. I asked whether he had come back from clubbing. He laughed.

He told me that his back is aching. We both have a history of it. He told me that he was going to take it easy.

I asked him whether he still travelled with his electric heating pad. He looked in his suitcase and it was there. I told him to plug it in and rest his back on it.

Then, he had problems connecting to the hotel wifi with his new tablet. I told him to open a browser and go to a Web page other than Google. Sure enough, the hotel page appeared, asking him to enter his special access code.

Finally, he let me know that he has changed banks and needs to update his bank account information to get paid. I told him that he can change all that information on our company's intranet site.
"What would you do without me?" I asked him.
"I don't know. I would be lost, for sure," he admitted.
"I should charge you for this support call," I joked.
"I can pay you in kisses," he hinted.
"I'd like that. It also shows that you are still my Cheap Bastard."
We then had another chat moments later.
"See, I am a good girl for helping you out," I pointed out.
"You're a useful girl, but never a good girl," he reasoned.
"You'll always be my Mr. Meanie," I told him.
"Yes, I like being your Mr. Meanie," he admitted.
Here's hoping that his back feels better soon.