Documentation as a prerequisite for successful CSIS

Complex System of Information Security (CSIS) comprises a set of organizational and technical measures aimed to ensure the protection of information circulating in the system from disclosure, leakage, and unauthorized access (c).

If your company is implementing the CSIS, it’s in for reinforced credibility and boosted sales. And you as a Technical Communicator are in for a bumpy ride. 😊

Let’s take a look at a grueling journey of meticulously described processes, roadmaps, and guidelines that need to accompany every stage of the System development.

Continue reading

Linear User Guide: Is It any Good?

Many believe that written user guides are doomed to extinction. Although their usage has diminished slightly, they are not clean gone yet. They are still with us—serving their particular audience and making us wonder what is the best approach to structuring them.

With the rise in the popularity of online documentation, many have ditched linearity and adopted a topic-based approach to writing—faster, more convenient, and definitely more efficient from the user perspective; absolutely challenging from the author perspective. But is such an approach still any good for structuring user guides which, unlike help systems, don’t provide immediate assistance to the user, differ in the very context of use, and are designed with a clear intention—to teach and guide?

Continue reading

Technical translation: lessons learnt

Any company operating in the international market simply cannot do without a Technical Translator. So, how can Technical Writers aid their companies in this matter? Well, by targeting their content at different audiences in different markets, Technical Writers often have to cooperate with localization specialists and deal with translation. But is technical translation such a seamless task? Let’s dig into its depths and try to come up with the best tips to follow whenever the task arises. Continue reading

Is the future of techcom in marcom?

At the outset of the new year, everyone is in anticipation of something new: new developments in the industry, new trends, and opportunities. Within techcom, one of the growing trends is the merge with marcom. Slowly gaining momentum, techcom is penetrating into marcom, literally blurring the subtle edges between the two seemingly different genres. There are even those claiming that the future of the techcom industry is in marketing. But what are the touching points between techcom and marcom, what might be the outcome of such a blend, and how will it impact Technical Communicators and the industry as a whole? And finally, is the complete merge of techcom and marcom possible after all? Continue reading

What if? Localizing a help system: coping tactics

What if a Technical Communicator without localization experience was commissioned a localization task? What if they accepted without being familiar with the localization guidelines? What if they failed? There are no definite answers to these questions, but the one, which is for sure certain, is that certain guidelines are to be followed. So, let’s take a look at what major problems and potential pitfalls may come up on the way of a Technical Communicator challenged to complete a task in which they haven’t gained enough experience yet.

Continue reading