It was only a short time ago that we migrated to DITA XML. We have been through two vendors and two content management systems (CMS). The second cost less than the first. However, earlier this year, someone in our company advocated that we move to Docs-as-Code to replace the CMS. It would also replace all … Continue reading Migrating to Docs-as-Code
Run basic Git commands
Although some people prefer user interfaces, I prefer using the command-line to work with Git. In this article, I will review the simple sequence that I use most often. First, I check out a branch. This might be the develop (integration) branch, or it might be a specific release. git checkout <branch> Next, I pull … Continue reading Run basic Git commands
Automatically create a list of Excel worksheet links
If you have an Excel spreadsheet with several worksheets, you might want to have a single worksheet at the beginning that has links to all the worksheets. Add the Developer Ribbon You must use the Developer tools to create the macro. Use the following procedure if you do not have access to this ribbon: In … Continue reading Automatically create a list of Excel worksheet links
Confluence tip: Create a link whose target opens in a new tab
To create a link and have the target open in a new tab, use the Wiki markup macro. 1. Go to the + at the top of the page. 2. Click { } Markup. 3. In the left side of the Insert markup page, type: {html} Your text <a href="https://url.com" target="_blank" </a> {html}. For example, if … Continue reading Confluence tip: Create a link whose target opens in a new tab
How to create a tooltip in WordPress
Have you ever wanted to add a tooltip in WordPress? It is truly very simple, once you know how to do it. Let's say you have the word "lollipop" in your content and when your reader hovers the cursor over the word, you want to describe a lollipop. While you are editing a page, click … Continue reading How to create a tooltip in WordPress
7 Tips for Proofing your Online Help
You have done a task analysis, asked your subject matter experts (SMEs) a multitude of questions, created drafts, worked with the software, reported bugs, and so on. Now, it is time to do a thorough review of your content before you hand it off to be reviewed for sign off. Before you press Send, do … Continue reading 7 Tips for Proofing your Online Help
When did I turn into a leader – six tips to getting your colleagues to want to work with you
I have never thought of myself as a leader. I am just me. I do my job. I am pretty enthusiastic because I love my job and the people. But, I think it is starting to sink in that I might actually be considered a leader. I am not sure if I was always one, … Continue reading When did I turn into a leader – six tips to getting your colleagues to want to work with you
Did I earn R.E.S.P.E.C.T.?
Ah, we as Technical Writers deal with this often. Lack of respect. Right? Although there is often a low simmer of this, I had somewhat forgotten about it because I have been fortunate enough to work with people who either respect what I do or at least pretend to. Last night, I stepped right back … Continue reading Did I earn R.E.S.P.E.C.T.?
You let me out of the cage, now you want to put me back in?
I am a telecommuter. I work from home full time. I have been doing it for several years at my current job, and I have done it in the past as well. It is the way I work best. Telecommuting is not for everyone. Friends wonder if I stare at the laundry or think about … Continue reading You let me out of the cage, now you want to put me back in?
Why conrefs are wonderful
I am currently documenting a command line interface that supports CRUD (Create, Read, Update, and Delete) operations for a variety of objects. As you can imagine, every object uses many of the same arguments. For example, when creating an object, the user can: Describe the object Activate the object Identify the type of data the … Continue reading Why conrefs are wonderful