You work hard preparing and maintaining technical content for your organization. You’re even committed to the “long game”— tackling the MadCap Flare learning curve. You know that committing to MadCap Flare for the long haul will pay huge dividends in the future. With Flare you will reduce repetition across all your content, you will improve consistency, you will be able to organize and manage critical data that is shared between documents, and you will be able to publish a myriad of formats with minimal effort. Lastly, you can significantly improve performance and increase cost savings when translating your content into multiple languages.
The way you design and execute tasks in Flare will say a lot about what is important to you and your organization and what goals it is trying to achieve. After assessing hundreds of translated Flare projects, we say a lot about a Flare project and who created it.
You apply inline styles instead of using CSS
Maybe you just have not had the chance to partake in training on CSS. Cascading Style Sheets are complex, and it takes time and effort to learn and master their use. If you are under pressure to “just quickly make documents available to the public” you might take some shortcuts. You might think, “What’s the big deal? I’ll just format text as I go.”
The truth is that by not benefitting from the advantages of CSS, you will bloat the underlying HTML code used by Flare. It will also make it difficult to make broad-sweeping changes. For example, let’s say you are documenting a software product, and you want all commands referenced in your content to be in Courier font, bolded, and italicized – but then you find out that Courier doesn’t look good in this context in Chinese. If you have not used a CSS style to manage this formatting, you will have to change all instances manually, which could be hundreds of instances. If this style had been defined in CSS, you could simply make one change and the problem would be solved.
You embed text in your images
Having static text in images means you simply need to link the image you want within a Flare topic without having to create text overlays and insert the text. This is a barrier for translation since the image will have to be recreated with the translated text. Additionally, if you must support multiple languages, the effort will have to be repeated for each language. Beyond this inefficient process, images often need tweaking due to text expansion or contraction. It is far more efficient to handle the textual part of your images within Flare.
A simple way to do this is to use MadCap Capture, a built-in image editing application that comes with Flare. It enables you to edit the image while using a layer of text that will not be flattened into the image.
You use conditions carefully
Using conditions is a core function in Flare that allows you to include or exclude text based on requirements for a specific document or output type. When using them, you must be mindful of how they are being used in English. For example, using conditions to manage plurals must be avoided. Say you condition the letter “s” to make nouns plural or singular based on the output – this will not work in languages that use different letters to form plurals.
You make the effort to make sure your Flare project is flawless
Ensuring that your Flare project is as error-free as possible if it is going to be used as the source project for translation is the most important thing you can do to ensure a cost-effective and accurate translation process. It is helpful to think in terms of “multiplying effects”. Translation itself is a multiplier. Errors in the source project will be copied to the translated project. One error becomes two. If you need to translate into five languages, one error is now five, and so on.
It is worth the extra time and effort to thoroughly check and correct your Flare projects before you publish them. If you make corrections prior to publishing in English, then the source project will be worthy of publication when translated. The best method to manage this is to have your own project QC checklist. It might contain:
- All necessary outputs can be produced and have been checked for errors.
- You have checked for broken links and missing images.
- You have reviewed targets for correct conditions and variables.
To be fair, no one should be judged by the state of their Flare project. Frankly, we have seen many Flare projects that were given lots of care and attention but still needed special attention and correction to work well for translation. It is impossible to know how a decision you make today may impact an Arabic translation that will be needed two years from now, and we would never judge you harshly for those decisions! The care, time, and effort you can put into your Flare projects is truly a reflection of your company’s priorities. If supporting your international customers with high-quality documentation is the goal, then be sure to advocate for the necessary time and resources to make your Flare projects shine.
Main Image: © Adobe Stock
