Bring Your Product Documentation White paper

Abstract. Since the start of my career in technical writing I’ve witnessed tremendous change in the way we perceive product documentation. If ten years ago almost nobody read the product manuals, nowadays everyone reads product documentation even before purchasing the product. Technology innovation is changing forever. Thus products are adapted to new horizon pushing communication via product documentation to new levels of unprecedented revolution. This whitepaper looks at product documentation key drivers that are revolutionizing the way we increase customer satisfaction while generating new leads. Multi-channel documentation will continue to shape the customer’s perception on a brand and the way figures run up. This is just the starting point for leveraging the benefits of your product documentation while bringing your product documentation on table. I hope this white paper will give a different perspective on the importance of documentation in all its formats and you will provide ongoing input… Read more...

Marketing radio systems solutions – Report

Abstract: This report evaluates vendors that sell end-to-end radio systems solutions for fleet management, system performance management, data transmission and telemetry and lone worker and personal security solutions.
Accept the dare to break out your comfort area, consider this article to break out of the conventional approaches of marketing your
radio systems solutions.
This report was conducted analyzing the providers listed within the Motorola MOTOTRBO™ Application Catalogue.
Research Highlights
This report highlights the following aspects:
  • Marketing innovation. Be smart.
  • Brand awareness. Communication channels.
  • Product documentation. Easy to find and read.
  • What’s next?

1. Website innovation. Be SEO 

Most of the companies activating in this niche are outdated in terms of new marketing technology and trends. You will see many old fashioned non-attractive websites. However, some smart guys who decided to keep the step with the trends rock in terms of the website look and feel. Yet they… Read more...

Performing a technical audit for an IT project developed with European funds

Performing a technical audit for an IT project developed with European funds
Scenario: One of the biggest security companies in Romania contacted me and a colleague of mine to perform a technical audit for a complex software solution, a CRM consisting of several modules: Patriot ERP, ticketing module and dispatcher module. The company contracted an outsourcing company to develop the IT project. We’ve never done this before, we have no accredited certification and yet we have the knowledge to perform a technical audit for an IT project. Why? We are two technical geeks who really understand how software projects/products are implemented, able to verify the product implementation against initial specifications.

1. Create the offer

Once you receive the request for proposal which includes the technical project description and hardware purchased, create the offer taking into consideration to have a plan in place. What will you audit? How do you organize… Read more...

Building high quality documentation for real-time dispatching solutions

Just recently I had the chance to rewrite and improve documentation for a varied range of products from two-way radio solutions to complex integrations of radio systems, thus entering a fascinating industry, one which addresses various services such as:
  • Public safety – reliable radio dispatches allow public institutions protect our communities.
  • Transportation industry – using radio dispatch communication and supervision provides better communication, security and a real-time overview on resources in the transportation sector: railways, airports and ports.
  • Exploration of natural resources – radio communication is also crucial in fields like: oil and natural gas, forestry and mining.
  • Utilities – Even if it’s hard to believe, dispatching solutions are very effective in assisting organizations providing electricity, gas, water and telecom services to our community. How? Dispatchers can easily communicate with operations teams, supervisors and emergency teams in the field, minimizing the interruptions to critical public services.
Basically, the dispatching solutions

Creating effective product labels

When we talk about technical communication in general we tend to refer to user documentation, online help, how-to use procedures and courses. But when we think to a software product the first technical communication type is the product labels, messages and indicators. Why? It is the first communication level with the users, giving minimal guidance on what and how to use the product. In general, product labels are created with user experience in mind, with a UX expert involved within the product design/development process. However, most companies do not have an UX expert, therefore developers are in charge of creating the product labels. As each role requires specific skills, developers are specialized in writing and rewriting code not product labels. Anyway, one solution to writing effective product labels is to involve technical writers and / or technical communicators to review the product labels created by developers. Why is this… Read more...

Winning Strategies for Technical Writers: 5 Key Steps for Success

End users tend to escape documentation when it comes to encountering issues with specific products. And there is a reason for this to happen; there are still many products which have useless end user documentation which does not offer clear flows; which lead to higher support costs for the companies. Why? A customer which cannot easily find solution to an issue will almost always pick up the phone and call the support department to get help.
The need to bridging the gap between end users and product documentation is vital across multiple industries. Learn how to overcome these challenges and successfully “deploy” valuable technical writing services.

Key Steps 1: Explore the product functionality

Learning the product helps you reduce the likelihood of making the common mistakes in documenting the flows. Always have in mind that hands-on experience with the product will make you the most valuable first user.
How do

Tracking the translation/localization of your documentation

Tracking the translation of your products’ documentation might give you headaches if not properly managed. Being in charge of managing the translation/localization of documentation in more than 12 languages for various products, I found out that the best way to ensure consistency between various product versions and languages is to organize documentation in products and product versions on the local file server also taking into consideration the file naming conventions.

Tracking the translation/localization of your documentation on the file server

  1. On the local file server, create a folder named Documentation.
  2. In the Documentation folder create folders for each product.
  3. Within each product file, create folders per product versions.
  4. Inside each product version folder create a folder per language.
  5. Within each language folder save the documents for the specific language taking into consideration the product and product version.

Tracking the translation/localization of your documentation using language filenames

Another important aspect for…

How to sell your tech colleagues that they should help you write good whitepapers

I’ve been talking to a good friend of mine the other days, Ioana Serban, Marketing Director at Computaris. A highly dedicated and passionate professional always trying to get the best out of people and delivering high quality marketing services to the customers. One of the issues she confronts with lately is convincing their global sales team and the system/solution architects that they should get more involved in their content creation strategy.
Read below Ioana’s thoughts on how to sell your tech colleagues that they should help you write good whitepapers. We all know that marketing is so hard to sell! Especially to the top management but also to the colleagues from the other departments. And when you need their input to promote your thought leadership in a technical domain you get stuck if you don’t manage to convince them to put some enthusiasm into helping you implement your inbound… Read more...