por khassler | Dic 28, 2019 | BlogHassler.ec, ClickHelp, Medium, Productividad, Programación, Technical Writer
Meet my tips for writing useful documentation that your users will read gladly. Prepare to Write Documentation The first step is preparation – on this step, you should: interview SMEs to learn more about the product; talk to a support team to learn what...
por khassler | Dic 23, 2019 | BlogHassler.ec, ClickHelp, DataBase, Design, Medium, Productividad, Programación, Technical Writer
Here is a list of tools that allow you to document your databases. Database Note Taker Database Note Taker is free, making it easy to capture and share knowledge about your databases and simplify database documentation. It provides developers, support staff and even...
por khassler | Dic 21, 2019 | BlogHassler.ec, ClickHelp, Design, Medium, Productividad, Programación, Technical Writer
There’s a joke about Google projects that people learn about only when their shutdown is announced. And we wouldn’t be surprised if you didn’t hear about a tool called Google Translator Toolkit. It was never trendy and remained a niche tool. With time, the number of...
por khassler | Dic 19, 2019 | BlogHassler.ec, ClickHelp, Design, Medium, Productividad, Programación, Technical Writer
The 11 most common technical writing mistakes we hope you don’t make, let’s go! Poor Design/Layout This is the first thing we are going to discuss and this is not by accident. Actually, the visual side of things is the first point of focus for your readers. You cannot...
por khassler | Dic 18, 2019 | BlogHassler.ec, ClickHelp, Medium, Productividad, Programación, Technical Writer
Do you have any second thoughts when spelling out things like two million three hundred thousand kilos? Or, on the contrary, when you prefer numerals in sentences like: Creating a new documentation portal will take you no longer than 1 minute! These sentences are...
por khassler | Dic 17, 2019 | BlogHassler.ec, ClickHelp, Medium, Productividad, Programación, Technical Writer
Werecently posted an article on using parallelism in technical writing and this was kind of thought-provoking. Parallel structure is one of the most commonly used literary devices and while its role is a bit different in literature and help authoring, it proves to be...
Comentarios recientes