TagsAdobe Acrobat Collaboration Dropbox Evernote Facebook Freelance Technical Writer Google Apps Google Apps for Business Google Apps Marketplace Google Docs Google Wave iOS iPad iPhone Job Hunting LinkedIn Mac Macintosh Messiah UMC Jobs Ministry Messiah United Methodist Church Jobs Ministry Microsoft Microsoft Office Microsoft Office 2010 Microsoft OneNote Microsoft SharePoint Microsoft Word OneNote OneNote 2010 Productivity Project management Resume Senior Technical Writer SharePoint SharePoint 2010 Social Media Technical documentation Technical Document Reviews Technical Writer Technical Writing TechRepublic Telecommuting Thyroid Twitter Will Kelly Writing and Editing
- Automatic App Store Updates…Nice. Could be a real timesaver for some. #iOS7 #wwd20132013/06/10 13:15
- Microsoft Office document support is going to be make or break for iWork for iCloud IMO.2013/06/10 13:18
- iWork for iCloud as a potential competitor to Google Apps for Business and Office WebApps could make things interesting.2013/06/10 13:50
- iWork is still getting some love…hmmm #WWDC2013/06/10 13:36
- Happy to hear the Mac Pro still lives. #wwdc132013/06/10 13:18
- The new OSX Mavericks calendar might actually bring me to using OSX calendar as my primary calendar again.2013/06/10 12:21
- My productive Monday morning now leads me into a potentially less productive afternoon full of #wwdc13 distractions.2013/06/10 11:13
- I'm a longtime fan. Now I need to decide what to do about their upcoming paywall:
- I edit docs but don't write on my tablets. Writers block: Cursing the cursor on Apple, Google tablets via @CNET
- How Fortune 500 companies are managing BYOD via @networkworld #BYOD
- Automatic App Store Updates…Nice. Could be a real timesaver for some. #iOS7 #wwd2013
Tag Archives: Technical Document Reviews
November 27, 2011 – 1:42 pm
While maintaining technical documents can be the most boring part of the technical writer’s job in some organizations, it’s a necessary part of the business especially in the federal government and other policies and procedure driven environments.
However, updating documents often falls down the list of priorities and becomes a reactionary task versus a natural element of business operations. This leads to such a simple task being flubbed and lapping up more resources and operational budget than first thought.
I am seeing more smaller contracts now for writers to come in an update technical documents especially policies and procedures guides and got to thinking how I like to update documents:
October 8, 2011 – 3:50 pm
I was a computer book technical reviewer earlier in my career. It was a freelance gig, but I still consider the work one of the more formative chapters in my professional writing career even though it wasn’t actually writing work.
Computer book technical reviewers sometimes called technical editors are responsible for ensuring the technical accuracy of computer book manuscripts. The work taught me to pay attention to technical details, which in turn went onto influence my work as a technical writer and freelance writer.
The lessons I learned include:
September 28, 2011 – 8:01 pm
I’ve written about hiring technical writers two or three times in the past with some interesting results. In fact, my initial article garnered me some not very nice emails from technical writers. It’s a timeless topic in my opinion so I wanted to go back and see if any of my initial advice and thoughts have changed in light of today’s economy.
There are still a lot of contrasting viewpoints on the role and skills of the technical writer that can even be confusing to technical writers themselves. This unnecessary confusion also leads to fallout that affects the salary and career mobility of technical writers. But as a hiring manager, it gives you more room to craft a technical writer position that can be of maximum benefit to your organization.
Here are my tips for hiring a technical writer:
August 21, 2011 – 5:41 pm
Every job hunt and even unsolicited discussions with recruiters bring me more tales of organizations continuing to have issues producing and maintaining technical documentation. It is not isolated in one sector and I keep hearing the same problems repeatedly. This has been a real disappointment for me over the years I was a contract technical writer and now that I have a staff technical writer job.
Developing technical documentation isn’t fun. Otherwise, it wouldn’t be such an afterthought. Things aren’t made any easier with a technical writing profession that is fragmented on the true role of the technical writer.
Here are some ways organizations sabotage their own technical documentation:
August 12, 2011 – 12:00 pm
Do organizations really need technical documentation style guides? It’s a question that rises on online forums every so often and today’s ever tightening workplace budgets should also put the role of the technical documentation style guide under the spotlight as well as organizations try to squeeze even more productivity out of their technical documentation dollars.
My answer to the style guide question is “Yes, organizations do need a style guide but it shouldn’t dominate the documentation development life cycle.” With the prevalence of online documentation and the web to deliver information plus more iterative development and launch cycles, the style guide should foster productivity and consistency not stand as a roadblock in the way of technical writers and training developers making deadlines.
June 11, 2011 – 1:00 pm
I’ve had a simmering interest in Office applications for mobile devices including the iPhone in particular. Therefore, since I already run iWork on my iPad, I downloaded the iWork apps for my iPhone when they first came available to me on the App Store.
Pages. Numbers, and KeyNote – the apps comprising iWork – are now considered “universal apps” meaning they work on the iPhone, iPod Touch, and the iPad. While my relationship with its Mac cousins can be described as off and on, I do use iWork and especially Pages on my iPad for reviewing documents (file attachments in particular). With the release of iWork for iPhone, I am hoping to use these apps the same way on my phone. I am looking forward to seeing how Apple can bring iWork syncing altogether with the upcoming launch of iCloud.
June 9, 2011 – 7:26 pm
I was out most of the afternoon during the WWDC Keynote address but caught up on my news that night. While the OS X Lion and iOS 5 announcements show a lot of potential, I am still holding my judgment over iCloud. Don’t get me wrong, the cloud is one area that seems to continually elude Jobs and Apple but I would like to see them turnaround their cloud strategy once and for all.
Here are my five questions about iCloud:
March 19, 2011 – 2:54 pm
I am now available for part-time technical writing projects that can be accomplished from my home office. Currently, my availability is 15-20 hours per week and I am able to make conference calls towards the end of the business day EST. My strong and diverse technical writing experience includes:
- Writing articles on technology and project management related topics for publication
- Writing user guides and online help for cloud based applications
- Reviewing and updating legacy technical documents
- Conducting technical reviews on computer book manuscripts
February 19, 2011 – 3:37 pm
A lot of my technical writing career has been spent as a contractor and consultant working with organizations that didn’t have technical documentation in place and need it in place fast. Throughout my travels, I’ve also spoken to even more organizations through the course of interviewing for potential projects. One thing I’ve learned is that Johnny can’t document a product.
Creating technical documentation isn’t rocket science nor does it require a select caste of individuals. A replicable process, some standards, maybe some templates, and oh yeah some common sense can really help your technical documentation efforts go the distance.
While some of the reasons why Johnny can’t document a product, these issues can sneak up an ultimately sabotage a documentation effort and ultimately the entire project.