Our first blog post on Git sparked discussions among different communities of tech writers. Many questioned the described workflow and highlighted that having to collaborate on the same file, pull and rebase changes daily, and resolve conflicts may be a sign of organizational and content management …

DSL? What DSL?The essence of the Kotlin DSLDemonstrationThree key strengths of our approachSeparation of ConcernsDocs-as-Code on a whole new levelExtensibilityWhy Kotlin?Do I need to be a coder to use the Kotlin DSL?Conclusion This material was initially presented at the API The Docs Conference i…

Write the Docs Portland Not that I can judge, as I'm not a frequent conference-goer, but Write the Docs (WTD) stands out from all others I have attended – the good, the bad, and the corporate.  A friendly and open community was eager to accept anybody who writes docs, whatever their o…

When I joined JetBrains back in 2014 as a senior technical writer, our team consisted of 5 documentarians covering 6 products.  We sat together in a separate room and kept our door closed most of the time, rarely mingling with any developers. We’d see them at the daily IntelliJ IDEA standup,…

It was hard to choose which tech writing conference to go to this year. Our team decided to spend the 2023 budget on these 7 conferences. The first one is over! Let us share our experience – biased maybe, but hopefully useful to those who plan to attend next year. Audience: There's a whole world …

To stay ahead of the curve, the Writerside team attends various events to discuss new trends, technologies, and best practices for authoring and publishing technical content. Come meet us, get a quick demo of our product, and discuss the latest developments in writing and publishing docs-as-code.

The more we work on a tool, the more intuitive and easy to use it seems. This is why documentation is sometimes postponed to the last minute, or even scrapped completely. Customers are left to figure out for themselves what the tool can do. However, documentation benefits even a small team, espec…

Single-source publishing is a powerful must-have feature that is normally among the top three competitive advantages for any professional help authoring solution – and for good reason. Single-sourcing reusable content lets you: Maintain consistency throughout your documentation in terms of style,…

One day you write some code, commit, push, and then receive a comment on the pull request: “Looks good. Oh, but you misspelled this word in a class name". Now you have to change the pull request just because of the typo. Annoying and time-consuming, isn't it? How IntelliJ IDEA spellchecks code …

A writing style guide is a set of rules and agreements for everyone involved in writing or editing documentation in a company. Usually, a style guide prescribes using certain words, expressions, terms, and punctuation. It can sometimes go even beyond that and cover content architecture or UI texts. …

When you ask someone what’s wrong with your documentation, the top 3 answers will be: no one reads it, it is misleading, and it is outdated. In this post, we will discuss how to keep your documentation up to date. Hey, doc! Why so outdated? Documentation is not source code. For code, you can w…