This year I had a marvelous opportunity to attend the Evolution of TC conference in Sofia, Bulgaria. It is an annual international event for all technical communicators with a focus on innovations in software documentation. Being a place for technical writers, information developers, translators, and everyone who is interested in technical communication, it gives an excellent opportunity to exchange knowledge and ideas, learn new tendencies and trends, as well as grow network. Continue reading
In the ever-changing work environment, Information Developers must constantly acquire new skills to stay professionally relevant. I assume that we all have our learning strategies and strive for perfection. As the saying goes, “practice makes perfect”. But how often do we give up the mere idea of learning just because we remember the popular theory of 10.000 hours of practice that inevitably separates us form perfection?
Today I would like to share my impression of the book “The First 20 Hours: How to Learn Anything… Fast” by Josh Kaufman, one of the world’s top 100 business authors. In his book, Kaufman explains that quick acquisition of any practical skill is possible within just 20 hours – or even less. The book, first published in 2013, became a bestseller right away. Since then, the idea that quick learning is possible keeps making a significant shift in the minds of aspiring learners. Continue reading
We, bloggers, dream to make our content visible, visited, and viewed. And even if we don’t think of SEO when starting our blogs, the time to look for tools for link building and keywords research always comes.
If you have already scratched the surface of the iceberg we call SEO or you just don’t want your website to be buried in the depth of Google search results, you surely need to know the notion of latent semantic indexing (LSI). And that’s when the article by Nikolay Stoyanov may be your first and foremost resource.
Whenever in the development team it comes to building interaction between software applications, creating an app for a web solution, or integrating back end services with the front end implementation – succinct and neat API documentation is of a tremendous value for all parties involved.
Make use of the resources below to develop effective API documentation and help your engineers disperse all uncertainties around the way of using a particular API.
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?
When creating diagrams, keep in mind that they should be easy to scan, understand, and interpret. This post provides practical tips on how to make your diagrams informative, visually appealing, and easy to comprehend.