Introducing Adobe’s Technical Communication Suite 2017

A new software release is always exciting. It comes with a promise that features you’ve been wanting might have been included. Problems (okay bugs) have hopefully been fixed. Sometimes, it even comes with more than you imagined.

Today, Adobe announced the release of its latest Technical Communication Suite – Release 2017 (TCS 2017). TCS 2017 is especially exciting for us because it will have its premier debut at MEGAComm, Israel’s annual conference for technical writers and marcom professionals!

I was honored to have been given a sneak preview and was amazed at the amount of changes, new features and advances that made it into this release. FrameMaker has been given a huge facelift. It has always been a workhorse, a solid, dependable application that was, to some extent boring. It did its job day in and day out, but without fanfare and without fuss.

In the last couple of versions, FrameMaker began making noise. Not content to be in the shadow of Microsoft Word, it broke out and away by adding HTML output. This latest version continues by focusing on simplification and it is…simply wonderful. There’s a new Search option that allows you to quickly type in the name of a command rather than have to remember on which menu the command is located. This feature alone will save you hours! Another amazing feature is the ability to allow users to search for text within SVG images! FrameMaker 2017 also enables you to auto-generate mini-TOCs (automatically updated, of course) for ALL supported outputs. I think the feature that I liked the best was one that would benefit my team – and that’s the new Insert menu. Everything you want to insert – images, files, variables, elements…in one easy place. Oh, and if you’ are someone who loves shortcuts (me, me, me), the menus have been modified to now include a listing of all the many shortcuts you can use.

Anyone who knows me, knows that I’ve been using, recommending, teaching RoboHelp almost since it was first released. In this latest version, Adobe continues to bring RoboHelp and FrameMaker closer and closer and yet still, RoboHelp remains the tool that enables you to more easily customize the look and feel of the output to the needs and preferences of your end-users. One great new feature I wouldn’t have thought to ask for and yet has frustrated me for years, is the ability to import whole folders, rather than individual files, to baggage files. Like FrameMaker, RoboHelp is setting the industry new standard with its Dynamic Content Filters, which finally lets your end-user choose the visible content according to tags you set. For example, if you support and sell multiple versions, users can select to see topics related to their specific version. Multiple user roles? A user from one role can filter results for that specific role (or any other). Multiple region support? Users from each region can filter out other regions dynamically while still having access to the information should they need to shift regions.

Considering that TCS 2017 was only released today, I guess I have time to detail other amazing features in the coming weeks and months as I familiarize myself more and more with the latest features Adobe has added to this version but from my brief sojourn into the world of TCS 2017, I can tell you it’s a solid, exciting, ground-breaking release and I look forward to writing about it again soon (and even more excited to really begin working with it for real as I move my work-related projects into 2017 and beyond).

Kudos to the Adobe team – you guys did a great job!

Leave a response

Latest Trends – Globalization

One of the greatest changes that has occurred in the field of technical writing over the last few years is the concept of globalization. This is a step beyond localization and a full two steps beyond translation. Let’s begin by defining the differences between these terms:

Translation

Translation is what companies have been doing for decades. Taking a document or an interface and converting it to another language. The same word structure, the same concepts, the same interpretation. What this means is that a manual that was written for the European market will be translated word by word for the Asian market, for the American market, for countries in Africa. Straight translation without consideration for the knowledge of the end user or how that end user will interpret the words. (An example of translation mistakes: 9 Little Translation Mistakes That Cause Big Problems).

Localization

Localization takes translation to another level. It is when a successful translator translates not merely the words, but the concepts from one language to another and more, from one society or culture to his or her own.

Globalization

And finally, globalization. Globalization is, in many ways, the opposite of localization. Localizing means making the content more understandable to the local market. It means translating the content and the context for local consumption. Globalization means smoothing out the differences; it means writing something in a way that it is universally understood. It means avoiding euphemisms, idiomatic phrases, cultural references, and local nuances.

As we write for the internet, we are more aware than ever before that the audience we are reaching crosses all borders – physical, cultural, perhaps even economic. In a recent document that I reviewed, I saw the phrase “crystal clear.” How will that translate? I asked the writer?

Well, in Hebrew, that would be phrased using language that, when translated back into English, would mean “as clear as the sun.” But if you spoke to an English speaker and said that something was as clear as the sun, they would likely wonder what you were trying to convey.

While technical writers are often challenged with learning new tools, globalization presents a major shift in how we write, the words we use, the audience we address. Bringing globalization back to the area of translation/localization. Without question, the more careful we are to write language and culture-agnostic content, the easier the translation process will be.

Also see:

Latest Trends – Introduction

Leave a response

Latest Trends – Part 1

We’ve been meaning to write this next series for some time now and so, here goes. Where is technical writing? Have we reached the end of the road? If not, where are we going? What are the latest frontiers for tech writers?

Well, the first thing we’d like to say is that we firmly believe that so long as there are engineers speaking to end-users, the world will need technical writers. Just as engineers and users have changed, so too have technical writers and so, here are some of the topics we’d like to cover in terms of future trends. Stay tuned as we cover each one.

  • Globalization – not just localization or translation, but true globalization
  • A change in the way we write, what we write, why we write and to whom we write
  • Deliverables – this is likely to be several posts and will discuss:
    • Mobile documentation
    • Video documentation
    • Dynamic content that the user can filter as needed
    • WIKIs
    • Corporate blogging and technical blogging
    • Embedded help

We’ll probably add more topics along the way but we’re excited to present this latest round of posts…

 

Leave a response

Enabling Users Dynamically

As a long-time RoboHelp user, I have to say one of the best features for end-users that Adobe has rolled out in recent years is the Dynamic Content Filters option. In many ways, past versions of RoboHelp and most help authoring products have focused on helping the help author rather than the help user. Great features have been added over the years – enhanced reviewing capabilities, improved help-to-print output, exciting new deliverables for mobile and HTML5 outputs, and much more.

But, in many ways, the user experience has been largely left untouched – perhaps not in look and feel (thanks to HTML5, etc.) but certainly in terms of functionality. RoboHelp 2015, and its “colleague” in the Technical Communications Suite, FrameMaker, now feature a way for the end-user to customize and filter what is displayed in the help window. This is done dynamically by selecting predetermined filters. This means, Admin users can focus on topics specific to Admin functionality or view the entire help at will. Users of Version 5 can filter out topics specific to that version, or, as in the past, sort through all topics.

What makes this feature particularly attractive to end -users is that it means that they have all the information at hand and can choose to read through any or all topics, or focus in primarily on their area of interest. In the past, it was the technical writer that decided what the end-user would receive and there was no way for the end-user to go beyond that which was provided by the tech writer.

Now, with this new feature, Adobe has enabled the end-user full access, while still enabling the tech writer to guide the focus of the reader. This is accomplished primarily with the familiar conditional tags functionality so that tech writers can still choose which topics are provided to each type of end-user, in addition to allowing the end-user to further filter  topics as needed.

The practical implications of this feature are quite extensive. Some examples:

  1. One of our clients had six different types of users. In the past, we gave the Admin users all of the information related to their tasks, as well as the other five user types. Each of the other five only had access to their related topics. There was the standard user which has the most basic tasks. Then, there was the branch manager, who was given topics related to both the standard user, as well as those of a branch manager. The regional manager, received standard, branch manager, and regional manager topics, and so on. Finally, the Admin was granted access to all of the other user categories. Now, with Dynamic Content Filters, the branch manager can quickly filter to view only standard tasks, branch manager tasks, or both combined. Similarly, the Admin can filter any level of user, effectively dividing the help project into six unique and very clear chunks of information.
  2. Another client had a product with several “live” versions released to clients at any given time. While end-users would only have to view topics related to their specific version, some updates affected more than one version at a time and so the engineers who reviewed the documentation used to have to view each output separately. With Dynamic Content Filters, the engineers can now filter per live version, or view the entire help file as one, including topics that were common to one or more versions.

There are many other ways that a technical writer can use the Dynamic Content Filters option. I have to admit that it is one that I enjoy presenting to potential clients because it has truly raised the standard of documentation, not just the ease of production, as in past RoboHelp versions, but quite literally, the level of usability for end-users as well.

Leave a response

Why Social Media is Important to Technical Writers

A long time ago…the world was created…and in this great world, there was a great order of communication with many laws. One law stated that engineers should not be allowed to speak to end-users and so, technical writers were born.

Okay, that’s not really how or why we were created. But the reality is, technical writers did come into existence because there was a gap between a user’s ability to instantly understand a program or a product without assistance…and his/her ability to understand a program or product WITH the assistance of an engineer/developer.

In many cases, what fascinates and impresses a developer has little to do with the end-user. There is so much knowledge that the developer has learned, that does not impact directly on the end-user’s typical workflow. And, by contrast, there is so much going on inside the minds of users that has little to do with the mechanics of creating the functionality within an application.

So, for years, technical writers have been writing; and end-users have been reading; and programmers have been developing. In more recent years, with the continued growth of social media, engineers are once again directly in touch with end-users…or they can be. The question, of course, is should they be?

It is at this moment, that we remember that there was a reason why technical writers were brought into the picture in the first place, and a reason why our participation in the user experience remains a critical element in the success of a product.

What has changed is not the need for our services as technical writers, but rather a need for us to expand what services we offer. We still need to provide valuable user content but now we need to be more involved in identifying and meeting the needs of users who want that information from a different access point. Rather than turn to the standard PDF user manuals, and perhaps even the help files we’ve been generating for years, users are turning to social media – to YouTube, Facebook and LinkedIn groups, etc.

The challenge for technical writers is to meet them there, in these other venues and provide answers there.

Leave a response

Managing a Global Team of Writers

I had the pleasure of presenting at TC World/TEKOM in Stuttgart last week. I’ve been to several international conferences in the last few years. In some cases, I was impressed; sometimes I was a bit disappointed. Often I felt very proud of our own conference here in Israel (MEGAComm). The audience in Stuttgart was respectful, interesting, engaging.

It was interesting presenting to a global audience, discussing how global teams should work. Here’s the presentation:

 

Leave a response

What Agile Brings to the Company…and to Documentation

An Agile environment offers many benefits (and challenges) to the company, to the technical writers, and to end-users. It is, without doubt, a challenge in and of itself because each sprint, each chunk of time between deliverables is much shorter than in a standard, non-Agile development cycle. Where once we planned 6-8 months ahead (and sometimes even longer), now we speak in intervals of two weeks to four weeks. We don’t speak of dozens of new features, but of a handful at most. In Agile, we are tasked with working within tight and regular deadlines. Before focusing on the challenges (another post), I want to focus first on the benefits, and there are many.

For the Company:

  • The best time for a company to promote a product is when it is new and fresh. By releasing regular updates – every 2 weeks or 4 weeks, the company is constantly announcing new features and regularly offering new incentives for new users to try their “updated” system and for existing users to upgrade.
  • In the past, with a 6 month or yearly release, the company would come out with a long list of new features. While this new product may attract tremendous attention in the market, five months into the new development cycle, as its competitors are announcing new features, the company appears, to the outside world, as being behind, stagnant, quiet. By releasing smaller amounts of features more often, the marketing department has more to work with, more hype to generate.
  • We all know that every product has bugs. If a company releases a product every 6 months or once a year, it is faced with the option of release “patches” – which, from a marketing point of view sound like…exactly what it is. The product didn’t work – we’re going to patch it (fix it) until the next release. In an Agile environment, you avoid many patches simply by including the bug fix in the upcoming release. Even in a worst case scenario, where a user discovers a bug the very day they upgrade, relief might be only 2 weeks away. In this case, Agile companies work with releases and hot fixes. A hot fix might be released for a show-stopper or a critical bug. Otherwise, one release away, the worst bugs are hopefully eliminated quietly and without much fanfare.

For the Developers:

  • By doing away with much of the standard work flow, developers are no longer working alone. Rather, they are part of a team and the team succeeds or fails as a unit. http://www.writepoint.com/blog/what-agile-brings-to-the-company-and-to-documentation/ http://www.writepoint.com/blog/what-agile-brings-to-the-company-and-to-documentation/ http://www.writepoint.com/blog/what-agile-brings-to-the-company-and-to-documentation/Knowledge is shared.
  • Downside for some engineers – they sometimes find themselves doing QA; upside – they sometimes find themselves doing QA 🙂
  • By dividing the “new features” requirements into segments, the developer should have a more granular schedule for deliverables. Instead of having 6 months to develop a set of features, each feature is “chopped” into smaller chunks that are likely more easier to estimate.
  • Rather than finding out 5 months into the 6th month cycle that the developer will not meet the deadlines, the schedule is more fluid in an Agile environment. A developer that can’t meet the 6 month deadline will be monitoring progress on a regular basis (once every 2 weeks or once a month, depending on the sprint interval). This means that the company will know, well in advance, if the schedule is slipping, and estimates can be adjusted as needed.

For the Technical Writer…stay tuned!

Leave a response

Scrum Resources

Over the last few months as we have watched one of our clients move to Agile, we’ve been asked by various project and product managers to help them figure out how documentation would function within their changing environment – the options were, at all times, relatively simple. In, out, alongside, after….

The complicated part was determining not what the options were, but which one would best serve the company and the end-users. During these discussions, we have used the following resources – to varying levels of success.

In no particular order and without any real endorsement, consider the following SCRUM / AGILE resources:

If you have other Agile resources – please share them!

Leave a response

Being agile in an Agile Environment

Another of our clients has decided to move to an Agile development environment. We’ve worked in this style before but this was one of the first times (if not the first time) that we were there before the environment.

It was an interesting experience, watching a not-really-startup company redesign how it develops and releases its product. They brought in an Agile expert to guide them and I enjoyed being in on the training. From the start, it was clear that the only person really thinking about documentation…was me.

Constantly, I wanted to interrupt and say, “but documentation doesn’t work that way?” and “If you do that, how do you expect us to have the documentation ready?” Sometimes, I raised this issue with the expert, sometimes with the product managers. http://www.writepoint.com/blog/being-agile-in-an-agile-environment/ http://www.writepoint.com/blog/being-agile-in-an-agile-environment/ http://www.writepoint.com/blog/being-agile-in-an-agile-environment/Each time, in the midst of training the developers and QA, scrum masters and the newly forming scrum team, I was told that the questions were great, but the timing was wrong.

In the next few posts, I would like to write about:

  • What Agile Brings to the Company…and to Documentation
  • What Agile Brings to the Technical Writer (this is next)
  • Where the Technical Writer Fits in an Agile Environment (stay tuned)
  • Problems and Challenges Technical Writers Face in Agile (coming soon)
  • Is Agile better for the user? (we’ll get here)
  • Is Agile better for the technical writer? (this is on my list)
  • Tips for Finding Your Place in an Agile Company (wait for it)
  • Scrum Resources

I’ll probably think of more along the way, but these work for now. Stay tuned for more, as I walk you through the birth of an Agile development documentation process.

Previous post:

Leave a response

How to Get a Job

Once again, I’ve chosen to join the JobMob annual guest blogging contest. To be honest, there’s something that bothers me about it – as much as they want quality content, ultimately it is all about how much traffic you can drive to their site in a short period of time. So, I’m running an experiment – I want to prove quality and quantity count – so please help me out.

The topic I chose was one that is important to me. I’ve spent the last 9 years of my life helping train people got get jobs. Mostly in the hi-tech area, but in other areas as well. In honor of their 8th annual contest, I thought of the top 8 skills that will help you interview and get a job.

The post is here: https://jobmob.co.il/blog/top-job-interviewing-skills/

So please help me win this contest by visiting this link (as often as you like!) – and because ultimately, what really does matter is content, please leave a comment and tell me what you think.

One of the requirements to enter the contest includes posting this information below:

Required Sponsor Posting:

Some very special sponsors have donated prizes to this contest in exchange for our posting information about them. This is not meant as an endorsement of their services and I cannot vouch for the accuracy of any claims made below as I am not familiar with them – but check them out if you get a chance.

Neil Patel’s Quicksprout Traffic U is the only online traffic school guaranteed to teach you to attract more visitors who will buy from you. Get the traffic your business needs.

Moz provides inbound marketing analytics software. They also foster the web’s most vibrant online marketing community and create free resources for learning inbound marketing.

Leave a response

Powered by WordPress | Designed by: Free WordPress Themes | Thanks to WordPress news theme, WordPress magazine theme and Premium WordPress Themes