New York, NY Technical Writer running in New York Marathon to raise funds for Harlem United

Vancouver technical writer racing in the Scotiabank half marathon, 2008
New York technical writer racing in a half marathon in 2008, leading up to the NY Marathon of 2016!

I have exciting news. As many of you know, I love running, especially on the awe-inspiring trails in Vancouver. To me, running provides a great balance to working as a technical writer at my computer. Much as I love working on projects for my clients, it can take a physical toll to spend too many hours at my desk, so I try to balance it out by running four times a week.

Now I have a great motivation to hit the trail at the end of the work day! I will be running in the New York Marathon on November 6, 2016 to raise money for Harlem United. My goal is to raise $3,000 for this fantastic organization that helps Harlem community members by providing access to health care, resources, and education about AIDS and HIV. They provide quality HIV prevention, housing, and care services in a safe and nurturing environment to unite Harlem’s diverse communities and address the needs of all people living with and threatened by HIV/AIDS.

I’m asking all my friends, family, clients, and colleagues to help support the amazing work that Harlem United does, and cheer me on in my dream of running the New York Marathon.

If you can help, please visit my donor page. You can sponsor me by:

  • Mile ($26 for the 26.2 miles of the marathon)
  • Kilometre ($42 for the 42 kilometres of the race)
  • Meal ($100 to buy a group lunch for LGBT youth at risk for contracting HIV)
  • Or pick your own amount!

Here is an inspirational video on YouTube about the impact Harlem United has made in helping people who had no hope.

I’ve been wanting to run in the New York Marathon for 20 years, since I first began running in 1996. It’s the largest marathon in the world (yikes!) and goes through all five boroughs of New York City. This will be my first full marathon, though I’ve run ten half marathons. I’m thrilled to finally run this race and to raise money for Harlem United.

Save

Save

New York Technical Writer judges STC 2016 International Summit Awards

I was honoured to participate in the prestigious Society for Technical Communication (STC) International Summit Awards (ISA) in two different roles this year. I served as both ISA Competition Judging Manager and as a judge. This meant I had the chance to view an exciting showcase of the top work in the field of technical writing.

The winning entries demonstrated exceptional technical writing clarity, organization, and delivery, with a strong focus on meeting the needs of the end user. The winning entries’ communication delivery methods displayed both brilliance and beauty, with innovative video and voice narration, breath-taking print artwork, and game-changing web-based delivery methods. I felt inspired to see the fantastic work that other technical writers are doing, and look forward to seeing further innovations next year.

Who Can Enter?

The ISA competition is open to entrants who have won a Distinguished or Excellence award at the chapter or regional level. Technical writers do not have to be a member of the STC to enter STC competitions. This year we had entries from North America, Europe, and Israel.

Highlights – Video and Judges

One of the highlights was viewing the video entries. I am very interested in the ways that video can be used to deliver and enhance technical communication. I developed a new set of criteria for judging videos, and will be helping to revise the judging forms for future competitions.

Another highlight was managing a team of 20 experienced and committed judges. I met new technical writers from across Canada and the US, and had the opportunity to both coach and learn as we worked together. In order to meet a very tight deadline, my amazing team judged 34 entries in just over a week. Well done, everyone!

Back to Top

New York Technical Writer converts to Twenty Sixteen

Google Analytics for WebsiteYou might notice my top-ranking Vancouver technical writer site looks a little different today. I updated to the WordPress twentysixteen theme. You may recall I gave an enthusiastic shout-out to WordPress last May, when I updated my site to use the twentyfifteen theme. I still think WordPress is awesome, and it would appear that website builders the world over agree with me. As of today’s date (February 6, 2016), 59.1% of websites in the world use WordPress, according to W3Techs.

It was a snap to make the change, taking about 2 hours total to select the theme, install it, create a few graphics in the right size, and make a few minor formatting tweaks. I added my own copyright information to the footer, customized the link font colour, and changed the font size for the tags in the left column. This is an amazing accomplishment (on the part of their coders to make the task so easy), and I am very appreciative of the service that WordPress provides for free to the world computing community.

I made these changes using a combination of the user-friendly WordPress editing platform and direct coding in the .php and .css files.

While I was at it, I took a look at my Google Analytics for the site. I thought it would be fun to compare the stats from the past month to the stats I reported in May 2015:

Device May 2015 Feb 2016
Desktop 918 – 92% 936 – 89%
Mobile Phone 70 – 7% 92 – 9%
Tablet 15 – 1% 26 – 2%
Total Visitors 1,003 1,054

The table above shows that the percentage of mobile users has increased slightly. Still, the majority of people who searched for a technical writer used their desktop computer, which makes sense. I imagine people would prefer to do this at work, not while lounging on the beach!

Browser May 2015 Feb 2016
Chrome 729 702
FireFox 115 127
Safari 72 108
Internet Explorer 31 90
Other 56 27
Total Visitors 1,003 1,054

No changes in the browser pecking order either, though the use of Internet Explorer did increase significantly.

I welcome your thoughts on the new site design. Drop me a line!

Back to Top

Save

New York Technical Writer updates to Twenty Fifteen

Vancouver Technical Writer Karen Rempel Updates Websites to WordPress Twenty FifteenThanks for visiting my revised website! Hi, I’m Karen Rempel, a Vancouver-based documentation specialist and senior technical writer.

I just updated this website to be mobile-friendly using the fantastic WordPress theme Twenty Fifteen. I also updated my BC Wilderness Visions website, using the same theme but different settings. Check it out to see the striking effects that can be achieved by simple colour changes.

I want to give a big shout-out to WordPress for this awesome theme. It only took me a day to update both websites to use this theme. I was previously using Silver Light by Blog Oh! Blog. I loved this theme and didn’t want to change, but Google forced me into action by notifying me that my Google ranking would slip if I didn’t make my site resizable for mobile phones and tablets. What can you do?

I checked out my Google Analytics for the past month, and found that of the 1000+ visitors to this technical writing website:

  • 918 used desktops. This is what I thought! My clients are typically at their desk at work when they think about their need for a technical writer, do a search, and call me.
  • 70 used their mobile phones.
  • 15 used their tablets.
Technical writers bridge people and technology

Technical writers bridge people and technologySo isn’t it interesting that people use technology to find technical writers? Most of my clients find me by searching on the internet. And thanks to Google Analytics, I know which devices they use, what countries they search from, and even what browser they use!

Here are the stats for browsers used to find this technical writing website:

  • Chrome – 729
  • FireFox – 115
  • Safari – 72
  • Internet Explorer – 31

Please drop me a line to let me know what you think of the new site! And if you like, tell us what device and browser you used to get here. 🙂

Back to Top

New York Technical Writer advises MadCap Flare content management for customized resumes

MadCap Flare WindowI recently completed a technical writing project for a Vancouver- and Calgary-based client who is a management consultant, program manager, and project manager in IT. Like many consultants, he has worked in a range of industries, and with over three decades’ worth of experience, he faces the challenge of condensing his experience and skills into a 3-page resume targeted to clients in two provinces. What would be a good way to solve this challenge? Enter MadCap Flare.

[Click the graphic to see a larger view that shows the use of condition tags]

Often thought of as an online help authoring tool, MadCap Flare is also a very user-friendly content management system (CMS). It provides a wide range of online and print-based output options (for example, Word, PDF, html). It uses XML as the backbone, making it easy to import source content and play nicely with most of the industry-standard authoring tools on the market today.

I thought that MadCap Flare’s CMS capabilities could help solve my client’s problem by providing a single-source database of skills and experience from which he can output a role- or industry-specific resume with one or two clicks of the mouse. In the words of our beloved Captain Jean-Luc Picard, I made it so.

I imported my friend’s main resume from Word, and then added in content from five other role-specific resumes, with conditional tags indicating which content belonged on which resume or CV. I set up two different style sheets, for two different looks – executive dark blue, and executive brown. I set up variable text for his phone, email, and mailing address, so he can select which of these to use on a given resume for a particular client. Then I created target outputs for nine different resumes. Et voila!

Target Options in MadCap FlareAll my client has to do is click Build Primary and then select the resume he wants to generate. But best of all, updating his resume with new experience is a snap. He can use MadCap Flare’s intuitive XML editor to type in new content, then apply conditional tags to specify which resume the content belongs with. Then simply use those same two mouse clicks to generate his new target resume. Beautiful. As you can tell, I am a fan of the Flare!

Of course, MadCap Flare isn’t cheap—a perpetual license is over $1,000 CAD (including tax). But for professionals who are aiming for top-paying consulting jobs, it is a reasonable career investment, and a tax write-off. If you are interested in creating your own database of role-oriented, industry-specific resumes, give me a call and I will be happy to help you.

Back to Top

Save

New York Technical Writer teaches simultaneous desktop and mobile design

Dolphin Celebration - Esalen Relaxation Massage VancouverI recently launched a new website for a Vancouver- and New York-based technical writing client. I designed and created the site using the WordPress theme Twenty Fourteen, which has been optimized for desktop, tablet, and mobile phone. Twenty Fourteen reorganizes the display of page elements based on the screen size of the device you are using. In contrast, the theme for this karenrempel.com technical writing website, Silver Light by Blog Oh! Blog, was developed in 2008 and does not resize on the fly. [Note: I updated karenrempel.com to a mobile-friendly format in April 2015.]

But there’s more to designing for mobile devices than just the capacity to automatically adjust the page elements. Here are some tips about mobile design for technical writers:

  • Keep the number of menu items to 6 or less. This is the maximum that can be displayed without scrolling on an iPhone.
  • Don’t use submenus. They are shown in expanded view when you open the menu on a tablet and present the reader with an overwhelming number of choices.
  • Use center alignment for graphics. Left or right alignment with text wrap leaves a column that’s too narrow for displaying text elegantly.
  • Put the phone number and action links near the top of the home page. Imagine your user is stopped at a light and wants to find the info before the light turns green! Not that anyone looks at their phone while driving, of course.
  • Launch all top-priority pages from links in the home page.

Whether you are a technical writer designing a website for a client, or designing your own technical writing website, I hope these tips will help you design a site that’s effective—both visually appealing and functional—on any device.

Back to Top

Save

New York Technical Writer provides Windows 8 work-arounds

Windows 8 lock screenHaving your computer die is one of those love it-hate it moments in life. There’s the excitement of getting to go out and spend a lot of money on electronics without guilt—we need our computers! There’s the thrill of seeing what’s new and great, and the promise of way more storage capacity and lightning-fast processor speeds. But if you use your computer for business, as I do for my technical writing business, there is the downside of the downtime, and the need to make a decision quickly and get back up and running ASAP.

My computer doctor Dave at Eltek Electronics, who gave me the news about the death of my old motherboard, warned me about Windows 8. He said try before you buy, so like a good technical writer I went to the London Drugs at Granville & Georgia, and spent a few minutes there looking at the new operating system, but it didn’t really register, what with the sales guy hovering around and telling me about fans and gaming speeds (very helpful info, and I love the quiet fan on my new laptop).

So it wasn’t until I brought my Dell Inspiron 15 home that the impact of Windows 8 really hit me. Start screen? What? Email login? What? Apps? What? No Start menu? What? Charms? What? Microsoft Security Essentials is gone? What? I was in for a week of googling to find out how to make my computer my own, with a pre-Windows 8 functional desktop. I must say, the internet community is awesome (full of excellent technical writers!), and I found everything I needed to know, from how to make changes to the registry to a free download for a Start menu simulator. So here are some tips, in case you find yourself in a similar situation, and like me, are in love with the old world ways.

Start Menu 8 – Free download, choice of which Windows-era Start menu button you want to use, access to Control Panel, Shut Down, Computer properties, Devices and Printers, and you can pin anything you want to the first page, just like in Windows Vista. Also provides the capability to disable the Windows 8 Start screen. Love it! CNet gives it 4 out of 5 stars. I give it 5.

Windows Essentials 2012 – If you have old emails from Windows Mail that you want access to, you need this software package, which includes Windows Live Mail, the replacement for Windows Mail. Includes Microsoft Silverlight (required for viewing web content on some sites), if you haven’t already downloaded it.

Malwarebytes Anti-Malware – My computer doc recommends this as the best free anti-virus software. I’ve been using it for years. He also recommends using Firefox (not Internet Explorer) to minimize infections. But you probably already know that.

Disable Upgrade Prompts – If you are like me and don’t want to be interrupted by annoying prompts to upgrade to Windows 8.1 (with no visible way to close the prompt and return to work—I had to use Ctrl-Alt-Del and shut it down with the Task Manager), this blog describes how to create a registry key to turn off the upgrade prompt.

BTW, if you are using regular Windows 8, the Group Policy Editor is not available. A lot of tips describe how to set up Windows 8 using the GPE, but it’s only available if you have Windows 8 Pro. So look for instructions that use the Registry Editor instead.

Disable Lock Screen – To go directly to the desktop when you start your computer, the lock screen is one of the screens you can eliminate. Follow the instructions in this blog entry to add a key to your registry to disable the lock screen.

Run box – If you are a real techie you already know this, but half-techie technical writersWindows key like me might wonder where the Run box has gone and how to get to it when you first start Windows 8. The Windows key+R opens the Run box. Once you install your new Start menu, it’s in Windows System > Run.

Windows Defender – Microsoft Security Essentials is now called Windows Defender. Unfortunately, there is no way to add this to the right-click menu to scan individual files. But you can use it to do full-computer scans. It’s in the Windows System folder on the Start menu.

I hope this will help my technical writing friends and clients get up to speed on Windows 8 and minimize downtime on your next computer upgrade.

Back to Top

New York Technical Writer discusses how technical writers add value to your company

If you are at this website, you probably already have a need for a technical writer. But you might not be aware of all the ways that a technical writer can add value to your company and improve your bottom line. Here are a few ways technical writers can contribute:

  • Technical writers provide documentation about your product or service that help your staff do their job more efficiently, reducing the time needed and improving quality of service.
  • Technical writers create materials that help customers have a positive experience while learning to use your product, through effective, easy-to-use training materials, online help, getting started guides, quick reference materials, or web-based training. A positive experience means customer loyalty, repeat business, and referrals to other potential customers.
  • Technical writers provide clear instructions that customers can use to quickly find the information they need, reducing calls to technical support lines, and therefore reducing your staffing costs.
  • Technical writers are advocates for the end user, and can contribute significantly during the product design stage, helping your developers deliver a product that is easy to understand and use.
  • Technical writers make your product look professional and increase its quality, through well-designed supporting materials and user interfaces. Nothing diminishes a product’s perceived quality like typos and spelling mistakes in the user interface or accompanying documentation!
  • Technical writers produce materials that are persistent aids to learning, which your staff or customers can refer to long after the training session is over. These materials are an asset to your company, and can be the factor that causes customers to choose your product or service over a competitor’s.

In sum, technical writers enhance your product or service, through increasing quality and customer satisfaction. They improve your staff’s performance through increasing efficiency and reducing customer support time, thereby reducing staff costs. Increased income and decreased costs mean great results for your bottom line!

Back to Top

New York Technical Writer says Camtasia video editing software rocks!

Camtasia in actionAs a technical writer, I love learning to use new software tools, whether for technical writing projects or for my own personal tasks. I recently had the challenge of editing a 12-minute video down to about 10 minutes. The other part of the challenge was that I wanted to do it myself, for free! A little googling revealed that Camtasia by TechSmith offers a free trial for 30 days, so I decided to give it a try.

What a great product! They are not paying me to say this! The software is super easy to use (for technical writers and non-technical writers alike), and they have lots of great written and video tutorials to get the task done right away (something a technical writer really appreciates). I quickly learned how to use the software, created some opening and end titles, and cut out the parts of the video I didn’t want. The timeline allows zooming in and out to edit on a frame-by-frame level if desired, or you can use the pictogram for the audio track to decide where to cut. You can highlight a section of film and then just press the spacebar to play it. Then drag to adjust the selection if necessary. Adding the titles from the clip bin was super easy too. (Click the picture for a bigger view of the user interface.)

It only took a Saturday of playing around to make the edits I wanted and upload the completed video to YouTube. If I ever need to buy video editing software for a longer project, I would definitely get Camtasia.

Back to Top

New York Technical Writer asks “Are you ready for April Fools’ Day?”

During the summer of 2011, British Columbians had the opportunity to participate in a province-wide referendum on the harmonized sales tax (HST). On August 26, 2011, Elections BC announced that British Columbians had voted in favour of eliminating the HST and returning to the provincial sales tax (PST) plus federal goods and services tax (GST) system. Good news for accountants, bookkeepers, and Vancouver technical writers!

Following the referendum results, government committed to make the transition back to the PST and GST system as quickly as possible. The Provincial Sales Tax Act received royal assent on May 31, 2012 and PST and GST will be re-implemented on April 1, 2013.

Yes, that is April Fools’ Day! But no fooling here—this is a case of BC citizens refusing to be forced to pay an additional tax. When HST was introduced in July 2010, many services that were previously just subject to 5% GST were suddenly subject to 12% HST. That’s a huge difference and it affected people and businesses alike. The good news for anyone who wants to hire a technical writer is that our rates will now be going down by 7%. No fooling!

So if you need the services of a technical writer—or any other service provider, for that matter—you’d be better off if you wait until April 1. Exceptions: legal services are subject to the 7% PST, as are services provided with regards to goods (for example, car repairs, computer installations, and so on).

If you need any help updating your procedural documentation to reflect the change in taxes, please don’t hesitate to give me a call. I am currently helping a major Crown Corporation to prepare for the tax change but I will be available on—you guessed it—April Fools’ Day!

Back to Top