The advantage of writing technical articles is not only the chance to share your knowledge with others but in particular, it deepens your understanding of a certain topic since you cannot explain what you haven't understood. In this short article, I want to share my technical setup with you and introduce you to the fairly simple review process I established for myself.
Let's start with the number one tool: The editor. I like to write my articles in markdown. As many publishing platforms these days support writing articles in markdown as well, it is just natural to write your articles in it. The syntax is not only easy but less distracting than LaTeX. Furthermore, it is easier to integrate into publishing processes than Microsoft Word documents.
I use Typora to write my articles. It is a free markdown editor, which is available for all major operating systems. What I like most about it is its simplicity. Markdown code is directly rendered, so you do not have a split-view like in Visual Studio Code (VS Code).
Recently, I discovered Mark Text, which seems a nice alternative to Typora. The major advantage that I see is that it is open-source, so it is easier to write custom extensions if needed. Yet, the keybindings are not as natural as the ones from Typora and it seems like I need to spend some more time getting my hands on it. For the moment, I go with Typora.
When I write technical articles, source code is usually included, too. The source code is not only tested but also shared via GitHub. Typically, I use VS Code to create the supporting material for my articles.
VS Code is much more light-weight than PyCharm. I use PyCharm mainly for big Python projects as it is better in that regard (at least in my humble opinion). However, the supporting material for my articles is mostly pretty small. Therefore, a heavy-weight IDE is not necessary.
Bonus: All functionalities provided by VS Code are free - for everyone. Furthermore, its set of third-party extensions is growing rapidly. In my opinion, it is worth checking out.
To ensure a quality that satisfies my aspirations, I established a review process, which consists of four steps.
And that's it! If you have any questions concerning the tools described in this article or the review process, do not hesitate to contact me. Furthermore, if you would like to be an author but do not know where to start, feel free to contact me, too!
I hope you enjoyed reading this article. Make sure to share it with your friends and colleagues. If you have feedback, let me know - I am eager to hear it! Also, make sure to follow me on Twitter, where I am @DahlitzF.