In the last time I had the need to write some documentation or even white papers. What kind of tool or editor should I choose?
Word is a good choice because I have a license 🙂 and know it well. Unfortunatly it lacks the possibility to produce HTML output and versioning the documents with git will not show you the differences between versions.
TeX / LaTeX generates beautiful output no matter if you choose PDF or HTML. But the learning curve is not very steep with a lot of plugins you have to know to integrate grafics or source code.
What I use a lot in my last projects is AsciiDoc because in the spring web projects I use Spring RESTdocs to test and describe the REST interfaces. So I tried to write other documentation with asciidoc and observed that the reaction of other team members is very positive.
Although I write asciidoc with my favorite IDE, IntelliJ IDEA, I feeled the need for a standalone editor. After a quick google search, I found AsciidocFx. This is an excellent little editor with many features that ease the editing of AsciiDoc files.
What I like most are the following features:
- With „Document helpers“ you can simply add document headers or other sections of the document. Choose „Article header“ for a quick start.
- The shortcuts in the symbol icons like „Hyperlink“ or „Table“ (a complete table generator).
- Integration of PlantUML by the „Extensions“ menu.
- Interactive preview shows new output while you type.
You get used to AsciiDoc while working with AsciidocFx. Give it a try!
It’s not a secret that my favorite IDE is IntelliJ IDEA. There are so many features, nobody (?) knows all of them. A few days ago I „discovered“ the postfix completion and want to share my knowledge with you. weiterlesen
When I tried to convert special data types like LocalDateTime into JSON I ran against a wall. It took me hours to find the solution. If you face the same problem, here is the solution: weiterlesen
Do you write your own library or framework and want to share it within your team? Then you should deploy your code to your own repository. I use Artifactory as a repository in my profession and I’m totally happy with this solution. Now I like to show you how easy it is to upload your code to the open-source version of Artifactory. weiterlesen
Although Tomcat is the most common application server it also tends to add some overhead to a small microservice. Lets have a look at the alternatives. weiterlesen
A lot of companies use a Windows server to host microservices. I asked myself „what is the best way to deploy and start a microservice?“. Of course, the microservice has to be a Windows service so that on every server restart the services are restarted too. But what else is necessary? weiterlesen
Did you ever deploy a jar to production and then need to change the log4j2 configuration for some package? Changing the jar on-the-fly or a new deployment was like stuck between a rock and a hard place. Then I found the following easy solution. weiterlesen
The easiest way to create a new Spring Boot project is the Initializr (http://start.spring.io). In this blog I want to show you how easy it is to create new projects with this tool. weiterlesen
Do you ever want to create a new full-blown project in 10 minutes? With all frameworks and configuration you most likely need? In the age of microservices there is the need to often create new projects with similar shapes. In this blog series I’ll show you how easy it can be to add several aspects to your new project. weiterlesen
Since more than 30 years I have to write good documentation. On the university I used to write documents with TeX and LaTeX because of the high quality output. The more professional the output is, the more professional the content looks to the reader. LaTeX offers a lot of possibilities to style your document so the reading can be fun. But LaTeX isn’t that simple. In my current projects I searched for a documentation tool that is wide spread, free and simple. The answer was Asciidoctor for me. weiterlesen