As advertised, Piktochart is a really easy-to-use infographic maker.
The story goes: I, an Information Developer, was asked to prepare a Case Study, quickly and in the form of an infographic. Sounds typical. But the branding dictates colors, size, opacity, and styling. Sounds like complex editing. Cheerful me took the friendliest tool and now can share my personal lessons learned.
Imagine a situation: you’re going to prepare a help system for a website. You suggest creating a help that has the look and feel of the website itself. The customer is happy with that, and you’re eager to start as you have MadCap Flare 11 or 12 with that cool TopNav output. However, the website uses custom fonts, and you need to use them in your help system.
What would you do?
Insightful article covering the following important aspects:
- What is Markdown?
- How and where to get started with Markdown in documentation?
- What points to consider?
All things considered, let’s put it that way:
Whereas Markdown is much simpler than HTML or any other markup language, it may introduce a lot of mess to documentation with complicated structure.
On the other hand, it may be quite enough to create simple docs (like, say, Release Notes) on a project.
What do you think?
A good help system portfolio showcases our smashing expertise better than a thousand words. But it’s very easy to deliver a portfoolio if you’re unaware of all pinpricks of MadCap Flare 10 or another help authoring tool (HAT) that you’re using.
This and more below, in less than a thousand words.
As an Information Developer, your work usually starts with opening an authoring tool of choice, creating a template and styles, writing the content, and producing a piece of consistent writing.
Well, most of the time. This applies to some 80–90 % of your time when you’re not busy digging information and interviewing SMEs. One of the things that you might be requested to do in your spare 10 % of time is to proofread some internal company or project documents. Usually, the process of proofreading involves Word documents and dealing with the following aspects:
- Spelling and grammar errors
- Naming conventions
- Overall structure and the level of details
A good spellchecker will save you the trouble of having to fix absolutely all spelling and grammar errors. There’s no proper artificial intelligence out there yet, so no one can handle structure and the level of details for you. But what do you do with formatting and naming conventions?